add screenReaderMode option

.github/workflows/nodejs.yml

@@ -4,6 +4,7 @@ on:
     branches:
       - master
       - canary
+      - screenreader
   pull_request:
 defaults:
   run:

app/config/config-default.js

@@ -160,6 +160,9 @@ module.exports = {
     // set to true to disable auto updates
     disableAutoUpdates: false,
 
+    // set to true to enable screen reading apps (like NVDA) to read the contents of the terminal
+    screenReaderMode: false,
+
     // for advanced config flags please refer to https://hyper.is/#cfg
   },
 

lib/components/term-group.tsx

@@ -104,6 +104,7 @@ class TermGroup_ extends React.PureComponent<TermGroupProps> {
       webLinksActivationKey: this.props.webLinksActivationKey,
       macOptionSelectionMode: this.props.macOptionSelectionMode,
       disableLigatures: this.props.disableLigatures,
+      screenReaderMode: this.props.screenReaderMode,
       uid
     });
 

lib/components/term.tsx

@@ -77,7 +77,8 @@ const getTermOptions = (props: TermProps): ITerminalOptions => {
       brightMagenta: props.colors.lightMagenta,
       brightCyan: props.colors.lightCyan,
       brightWhite: props.colors.lightWhite
-    }
+    },
+    screenReaderMode: props.screenReaderMode
   };
 };
 

lib/components/terms.tsx

@@ -116,6 +116,7 @@ export default class Terms extends React.Component<TermsProps> {
             webLinksActivationKey: this.props.webLinksActivationKey,
             macOptionSelectionMode: this.props.macOptionSelectionMode,
             disableLigatures: this.props.disableLigatures,
+            screenReaderMode: this.props.screenReaderMode,
             parentProps: this.props
           });
 

lib/config.d.ts

@@ -51,6 +51,7 @@ export type configOptions = {
   };
   padding: string;
   quickEdit: boolean;
+  screenReaderMode: boolean;
   scrollback: number;
   selectionColor: string;
   shell: string;

lib/containers/terms.ts

@@ -45,7 +45,8 @@ const mapStateToProps = (state: HyperState) => {
     webGLRenderer: state.ui.webGLRenderer,
     webLinksActivationKey: state.ui.webLinksActivationKey,
     macOptionSelectionMode: state.ui.macOptionSelectionMode,
-    disableLigatures: state.ui.disableLigatures
+    disableLigatures: state.ui.disableLigatures,
+    screenReaderMode: state.ui.screenReaderMode
   };
 };
 

lib/hyper.d.ts

@@ -79,6 +79,7 @@ export type uiState = Immutable<{
   quickEdit: boolean;
   resizeAt: number;
   rows: number | null;
+  screenReaderMode: boolean;
   scrollback: number;
   selectionColor: string;
   showHamburgerMenu: boolean | '';
@@ -287,6 +288,7 @@ export type TermGroupOwnProps = {
   | 'onTitle'
   | 'padding'
   | 'quickEdit'
+  | 'screenReaderMode'
   | 'scrollback'
   | 'selectionColor'
   | 'sessions'
@@ -344,6 +346,7 @@ export type TermProps = {
   padding: string;
   quickEdit: boolean;
   rows: number | null;
+  screenReaderMode: boolean;
   scrollback: number;
   search: boolean;
   searchAddon: SearchAddon | null;

lib/reducers/ui.ts

@@ -107,7 +107,8 @@ const initial: uiState = Immutable<Mutable<uiState>>({
   webGLRenderer: true,
   webLinksActivationKey: '',
   macOptionSelectionMode: 'vertical',
-  disableLigatures: true
+  disableLigatures: true,
+  screenReaderMode: false
 });
 
 const reducer: IUiReducer = (state = initial, action) => {
@@ -264,6 +265,10 @@ const reducer: IUiReducer = (state = initial, action) => {
               ret.disableLigatures = config.disableLigatures;
             }
 
+            if (config.screenReaderMode !== undefined) {
+              ret.screenReaderMode = config.screenReaderMode;
+            }
+
             ret._lastUpdate = now;
 
             return ret;