microsoft / microsoft/monaco-editor

[Bug] Accessibility Help missing

Open
#4,908 2 comments 4 reactions 0 assignees View on GitHub

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?
Monaco Editor Playground Link

https://microsoft.github.io/monaco-editor/playground.html?source=v0.40.0#example-creating-the-editor-hello-world

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:

  1. Open the command palette (F1)
  2. search for "accessibility"

B:

  1. 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.