microsoft / microsoft/monaco-editor
[Bug] Accessibility Help missing
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 46.8k
- Forks
- 4.1k
- Avg merge
- 17h 58m
- Merged PRs (30d)
- 1
Description
Reproducible in vscode.dev or in VS Code Desktop?
- Not reproducible in vscode.dev or VS Code Desktop
Reproducible in the monaco editor playground?
- Not reproducible in the monaco editor playground
Monaco Editor Playground Link
Monaco Editor Playground Code
const value = /* set from `myEditor.getModel()`: */ `function hello() {
alert('Hello world!');
}`;
// Hover on each property to see its docs!
const myEditor = monaco.editor.create(document.getElementById("container"), {
value,
language: "javascript",
automaticLayout: true,
accessibilityHelpUrl: 'github.com'
});
Reproduction Steps
A:
- Open the command palette (F1)
- search for "accessibility"
B:
- Press Alt+F1 (open accessibility help)
Actual (Problematic) Behavior
A:
- Nothing is available
B:
- Nothing happens
Expected Behavior
A:
- "Show Accessibility Help" option is available
B:
- Accessibility Help pop-over opens
Additional Context
As a result on https://github.com/microsoft/vscode/issues/179689#issuecomment-2883984545 , stand-alone monaco editor on the web no longer has the accessibility help dialog. It is not accessible through the previously used Alt+F1 shortcut nor is the "Show Accessibility Help" command available in the command palette.
And since the dialog is missing, the accessibilityHelpUrl configuration parameter (https://microsoft.github.io/monaco-editor/docs.html#interfaces/editor.IStandaloneEditorConstructionOptions.html#accessibilityHelpUrl) is also not usable.
This makes the stand-alone monaco editor less accessible, as now there is no way for users to discover the screen reader optimizations or switch out Tab key effect (Control+Shift+M shortcut that still works).
I see that the information about Accessibility Help menu has been removed from the monaco editor accessibility wiki page (https://github.com/microsoft/monaco-editor/wiki/Monaco-Editor-Accessibility-Guide/_compare/acf6ee45faa4a210c55cba7d8373ba5b7b185b69...bc5d5974a5e422178c4b0cb4afe9850393f11635), but it's still mentioned in the Accessibility Guide for Integrators (https://github.com/microsoft/monaco-editor/wiki/Accessibility-Guide-for-Integrators).
Is there a new recommended approach to add accessibility help in the use-case of stand-alone monaco editor (non-vscode) integration?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the standalone editor command palette and Alt+F1 accessibility-help entry points, using the linked Monaco Editor Playground reproduction. Check how accessibilityHelpUrl is expected to connect to the help pop-over; done means the command and shortcut open Accessibility Help for standalone integrations, or the supported replacement is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- accessibility, frontend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100