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

New plugin (token) for aria-live #16145

Open
krassowski opened this issue Apr 10, 2024 · 2 comments
Open

New plugin (token) for aria-live #16145

krassowski opened this issue Apr 10, 2024 · 2 comments

Comments

@krassowski
Copy link
Member

krassowski commented Apr 10, 2024

Problem

Better screen-reader integration was requested/proposed in a few issues/pull requests:

However, there is repetitive code in #15048 and #15554 which writes directly to DOM elements to cause the side-effect of reading out text by screen reader. As highlighted in the reviews:

  • this needs customization such as the delay for #15554
  • the entries need to be cleaned at some timeout to avoid memory leak
  • user needs to be able to toggle this feature off

Proposed Solution

Create a new plugin with a public API to announce() a message to screen users, and with settings to provide customisability.

Additional context

None

@krassowski krassowski added enhancement status:Needs Triage Applied to new issues that need triage tag:Accessibility labels Apr 10, 2024
@krassowski
Copy link
Member Author

I'm not quite sure where this plugin should live. So far the aria-live region element was proposed to be added to the shell in application package, which is good in the sense that everyone gets access to it, but is not great for reusability (we would want to have it in Notebook to, but notebook has a different application).

A new package is an option, though it seems a bit slim, so maybe apputils?

@krassowski krassowski added this to the 4.3.0 milestone Apr 11, 2024
@krassowski
Copy link
Member Author

Note: cross-check with interface for jupyterlab logger and with the announcements API

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants