Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add accessibility toggle #37758

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
40 changes: 38 additions & 2 deletions client/src/templates/Challenges/classic/Editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ import { createSelector } from 'reselect';
import {
canFocusEditorSelector,
executeChallenge,
inAccessibilityModeSelector,
setEditorFocusability,
setAccessibilityMode,
updateFile
} from '../redux';
import { userSelector, isDonationModalOpenSelector } from '../../../redux';
Expand All @@ -22,23 +24,28 @@ const propTypes = {
executeChallenge: PropTypes.func.isRequired,
ext: PropTypes.string,
fileKey: PropTypes.string,
inAccessibilityMode: PropTypes.bool.isRequired,
setAccessibilityMode: PropTypes.func.isRequired,
setEditorFocusability: PropTypes.func,
theme: PropTypes.string,
updateFile: PropTypes.func.isRequired
};

const mapStateToProps = createSelector(
canFocusEditorSelector,
inAccessibilityModeSelector,
isDonationModalOpenSelector,
userSelector,
(canFocus, open, { theme = 'default' }) => ({
(canFocus, accessibilityMode, open, { theme = 'default' }) => ({
canFocus: open ? false : canFocus,
inAccessibilityMode: accessibilityMode,
theme
})
);

const mapDispatchToProps = {
setEditorFocusability,
setAccessibilityMode,
executeChallenge,
updateFile
};
Expand Down Expand Up @@ -114,7 +121,12 @@ class Editor extends Component {

editorDidMount = (editor, monaco) => {
this._editor = editor;
if (this.props.canFocus) {
this._editor.updateOptions({
accessibilitySupport: this.props.inAccessibilityMode ? 'on' : 'auto'
});
// Users who are using screen readers should not have to move focus from
// the editor to the description every time they open a challenge.
if (this.props.canFocus && !this.props.inAccessibilityMode) {
this._editor.focus();
} else this.focusOnHotkeys();
this._editor.addAction({
Expand All @@ -135,9 +147,33 @@ class Editor extends Component {
this.props.setEditorFocusability(false);
}
});
this._editor.addAction({
id: 'toggle-accessibility',
label: 'Toggle Accessibility Mode',
keybindings: [monaco.KeyMod.CtrlCmd | monaco.KeyCode.F1],
run: () => {
const currentAccessibility = this.props.inAccessibilityMode;
// The store needs to be updated first, as onDidChangeConfiguration is
// called before updateOptions returns
this.props.setAccessibilityMode(!currentAccessibility);
this._editor.updateOptions({
accessibilitySupport: currentAccessibility ? 'auto' : 'on'
});
}
});
this._editor.onDidFocusEditorWidget(() =>
this.props.setEditorFocusability(true)
);
// This is to persist changes caused by the accessibility tooltip.
// Unfortunately it relies on Monaco's implementation details
this._editor.onDidChangeConfiguration(() => {
if (
this._editor.getConfiguration().accessibilitySupport === 2 &&
!this.props.inAccessibilityMode
) {
this.props.setAccessibilityMode(true);
}
});
};

focusOnHotkeys() {
Expand Down
11 changes: 10 additions & 1 deletion client/src/templates/Challenges/redux/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ const initialState = {
},
challengeTests: [],
consoleOut: '',
inAccessibilityMode: false,
isCodeLocked: false,
isBuildEnabled: true,
modal: {
Expand Down Expand Up @@ -78,7 +79,8 @@ export const types = createTypes(

'moveToTab',

'setEditorFocusability'
'setEditorFocusability',
'setAccessibilityMode'
],
ns
);
Expand Down Expand Up @@ -152,6 +154,7 @@ export const submitChallenge = createAction(types.submitChallenge);
export const moveToTab = createAction(types.moveToTab);

export const setEditorFocusability = createAction(types.setEditorFocusability);
export const setAccessibilityMode = createAction(types.setAccessibilityMode);

export const currentTabSelector = state => state[ns].currentTab;
export const challengeFilesSelector = state => state[ns].challengeFiles;
Expand Down Expand Up @@ -223,6 +226,8 @@ export const challengeDataSelector = state => {
};

export const canFocusEditorSelector = state => state[ns].canFocusEditor;
export const inAccessibilityModeSelector = state =>
state[ns].inAccessibilityMode;

const MAX_LOGS_SIZE = 64 * 1024;

Expand Down Expand Up @@ -359,6 +364,10 @@ export const reducer = handleActions(
[types.setEditorFocusability]: (state, { payload }) => ({
...state,
canFocusEditor: payload
}),
[types.setAccessibilityMode]: (state, { payload }) => ({
...state,
inAccessibilityMode: payload
})
},
initialState
Expand Down