github/arianotify-polyfill
Watch
1
0
Fork
You've already forked arianotify-polyfill
 0
mirror of https://github.com/github/arianotify-polyfill synced 2026-07-22 21:23:52 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
173 commits 8 branches 16 tags 955 KiB
  • JavaScript 98.2%
  • HTML 1.8%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Joyce Zhu dc56c69d7e
 chore(deps): Bump ws (#64) 
Bumps and [ws](https://github.com/websockets/ws). These dependencies
needed to be updated together.
Updates `ws` from 7.5.10 to 7.5.11
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/websockets/ws/releases">ws's
releases</a>.</em></p>
<blockquote>
<h2>7.5.11</h2>
<h1>Bug fixes</h1>
<ul>
<li>Backported 2b2abd45 to the 7.x release line (e14c4586).</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="fd36cd864f"><code>fd36cd8</code></a>
[dist] 7.5.11</li>
<li><a
href="e14c45861d"><code>e14c458</code></a>
[security] Limit retained message parts</li>
<li>See full diff in <a
href="https://github.com/websockets/ws/compare/7.5.10...7.5.11">compare
view</a></li>
</ul>
</details>
<br />

Updates `ws` from 8.18.3 to 8.21.0
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/websockets/ws/releases">ws's
releases</a>.</em></p>
<blockquote>
<h2>7.5.11</h2>
<h1>Bug fixes</h1>
<ul>
<li>Backported 2b2abd45 to the 7.x release line (e14c4586).</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="fd36cd864f"><code>fd36cd8</code></a>
[dist] 7.5.11</li>
<li><a
href="e14c45861d"><code>e14c458</code></a>
[security] Limit retained message parts</li>
<li>See full diff in <a
href="https://github.com/websockets/ws/compare/7.5.10...7.5.11">compare
view</a></li>
</ul>
</details>
<br />


Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/github/arianotify-polyfill/network/alerts).

</details>
2026-07-09 21:25:56 +00:00
.github chore(deps): Bump actions/checkout 2026-06-23 06:13:18 +00:00
examples fix: Commit with case-sensitivity 2025-07-25 09:50:14 -04:00
tests fix: Remove unused symlink 2026-05-29 15:36:38 -04:00
.gitignore tests: Add '<live-region>' placement tests 2025-04-11 09:50:11 -04:00
.npmrc chore: apply security best practices 2026-05-28 09:07:50 -04:00
arianotify-polyfill.js Rename ariaNotify test bypass 2026-05-29 15:18:35 -04:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2024-09-10 12:14:43 +01:00
CODEOWNERS Update CODEOWNERS 2024-11-19 16:41:24 -06:00
CONTRIBUTING.md fix: Use lowercase in package and module name 2025-07-25 08:43:36 -04:00
LICENSE Initial commit 2024-07-08 10:59:20 -04:00
package-lock.json chore(deps): Bump ws 2026-07-09 19:15:40 +00:00
package.json chore(deps-dev): Bump the npm-minor-and-patch group across 1 directory with 2 updates 2026-06-16 06:13:25 +00:00
playwright.config.mjs Use Chrome for Guidepup tests 2026-05-29 15:44:05 -04:00
README.md feat: Implement on 'Document' 2025-07-25 13:44:14 -04:00
SECURITY.md Create SECURITY.md 2024-09-10 12:15:07 +01:00
SUPPORT.md fix: Use lowercase in package and module name 2025-07-25 08:43:36 -04:00
web-test-runner.config.js fix: Use Chrome, Web Test Runner’s default browser 2026-05-29 15:41:29 -04:00

README.md

arianotify-polyfill

Polyfill for the ARIA Notification API

The goal of this library is to polyfill ariaNotify so that it can be used seamlessly across browsers that support the native functionality, and those that don't. This adds the Element.prototype.ariaNotify and/or Document.prototype.ariaNotify functions if they do not exist, emulating the native functionality.

This is used in production on github.com.

Background

In browsers where ariaNotify is supported it will emit a notification event. In browsers where it isn't supported this library will create a "fake" element that is an aria-live region, insert it into the DOM, and modify the text content of the element to place the given message in, achieving a similar effect to the native functionality.

Requirements

This is only meant to be used in a browser context. It should not be used on the server. To install this you will likely need npm.

$ npm i @github/arianotify-polyfill

In your JavaScript you can introduce the polyfill using a "bare" import:

import "@github/arianotify-polyfill"

Then continue to use ariaNotify as if it were supported everywhere. A small contrived example:

button.ariaNotify("Saved")

License

This project is licensed under the terms of the MIT open source license. Please refer to MIT for the full terms.

Maintainers

The @github/accessibility and @github/primer teams maintain this library.

Support

This library is provided "as is". Please feel free to file issues; however, we offer no time frame for correspondence or resolution of any issues.

Acknowledgement

Special thanks to Microsoft and the ARIA Working Group for making ariaNotify a possibility.