a11y-status
Advanced tools
Comparing version 1.0.0-next.22 to 1.0.0-next.35
# a11y-status | ||
## 1.0.0-next.35 | ||
> 2020-09-13 | ||
### Patch Changes | ||
- [`725df02b`](https://github.com/remirror/remirror/commit/725df02b53fa16b9c7a3768b0c9464e739e35813) [#672](https://github.com/remirror/remirror/pull/672) Thanks [@ifiokjr](https://github.com/ifiokjr)! - Reduce bundle size by updating babel configuration thanks to help from [preconstruct/preconstruct/297](https://github.com/preconstruct/preconstruct/issues/297#issuecomment-690964802). [Fixes #358](https://github.com/remirror/remirror/issues/358). | ||
## 1.0.0-next.22 | ||
@@ -9,4 +17,3 @@ | ||
- 113560bb: Required temporary fix to resolve issue with unlinked packages in prerelease mode. See | ||
the [issue](https://github.com/atlassian/changesets/issues/442) for more details. | ||
- 113560bb: Required temporary fix to resolve issue with unlinked packages in prerelease mode. See the [issue](https://github.com/atlassian/changesets/issues/442) for more details. | ||
@@ -59,5 +66,3 @@ ## 1.0.0-next.4 | ||
- The whole API for remirror has completely changed. These pre-release versions are a breaking | ||
change across all packages. The best way to know what's changed is to read the documentaion on the | ||
new documentation site `https://remirror.io`. | ||
- The whole API for remirror has completely changed. These pre-release versions are a breaking change across all packages. The best way to know what's changed is to read the documentaion on the new documentation site `https://remirror.io`. | ||
- 09d91abf: Rename `@remirror/ui-a11y-status` to `a11y-status`. |
@@ -13,2 +13,2 @@ /** | ||
*/ | ||
export declare const setStatus: (status: string, doc?: Document) => void; | ||
export declare const setStatus: (status: string, doc?: Document | undefined) => void; |
{ | ||
"name": "a11y-status", | ||
"version": "1.0.0-next.22", | ||
"description": "Create a singleton live region for a11y status updates", | ||
"homepage": "https://github.com/remirror/remirror/tree/HEAD/packages/a11y-status", | ||
"repository": "https://github.com/remirror/remirror/tree/HEAD/packages/a11y-status", | ||
"license": "MIT", | ||
"contributors": [ | ||
"Ifiok Jr. <ifiokotung@gmail.com>" | ||
], | ||
"main": "dist/a11y-status.cjs.js", | ||
"module": "dist/a11y-status.esm.js", | ||
"browser": { | ||
"./dist/a11y-status.cjs.js": "./dist/a11y-status.browser.cjs.js", | ||
"./dist/a11y-status.esm.js": "./dist/a11y-status.browser.esm.js" | ||
}, | ||
"types": "dist/a11y-status.cjs.d.ts", | ||
"files": [ | ||
"dist" | ||
], | ||
"dependencies": { | ||
"@babel/runtime": "^7.11.0", | ||
"@types/throttle-debounce": "^2.1.0", | ||
"throttle-debounce": "^2.3.0" | ||
}, | ||
"publishConfig": { | ||
"access": "public" | ||
}, | ||
"meta": { | ||
"sizeLimit": "1 KB" | ||
} | ||
"name": "a11y-status", | ||
"version": "1.0.0-next.35", | ||
"description": "Create a singleton live region for a11y status updates", | ||
"homepage": "https://github.com/remirror/remirror/tree/HEAD/packages/a11y-status", | ||
"repository": "https://github.com/remirror/remirror/tree/HEAD/packages/a11y-status", | ||
"license": "MIT", | ||
"contributors": [ | ||
"Ifiok Jr. <ifiokotung@gmail.com>" | ||
], | ||
"main": "dist/a11y-status.cjs.js", | ||
"module": "dist/a11y-status.esm.js", | ||
"browser": { | ||
"./dist/a11y-status.cjs.js": "./dist/a11y-status.browser.cjs.js", | ||
"./dist/a11y-status.esm.js": "./dist/a11y-status.browser.esm.js" | ||
}, | ||
"types": "dist/a11y-status.cjs.d.ts", | ||
"files": [ | ||
"dist" | ||
], | ||
"dependencies": { | ||
"@babel/runtime": "^7.11.0", | ||
"@types/throttle-debounce": "^2.1.0", | ||
"throttle-debounce": "^2.3.0" | ||
}, | ||
"publishConfig": { | ||
"access": "public" | ||
}, | ||
"meta": { | ||
"sizeLimit": "1 KB" | ||
} | ||
} |
# a11y-status | ||
[![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/a11y-status.svg?)](https://bundlephobia.com/result?p=a11y-status) | ||
[![npm](https://img.shields.io/npm/dm/a11y-status.svg?&logo=npm)](https://www.npmjs.com/package/a11y-status) | ||
[![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/a11y-status.svg?)](https://bundlephobia.com/result?p=a11y-status) [![npm](https://img.shields.io/npm/dm/a11y-status.svg?&logo=npm)](https://www.npmjs.com/package/a11y-status) | ||
## Problem | ||
You'd like to update your screen reader users on changes in the status of your ui but don't want to | ||
create multiple dom elements to notifiy them. | ||
You'd like to update your screen reader users on changes in the status of your ui but don't want to create multiple dom elements to notifiy them. | ||
### Solution | ||
Inject a visually hidden singleton element in the dom which is responsible for notifying screen | ||
reader users of updates to the accessibility status of the UI. | ||
Inject a visually hidden singleton element in the dom which is responsible for notifying screen reader users of updates to the accessibility status of the UI. | ||
@@ -24,9 +21,7 @@ ## Installation | ||
Note that the `11` is the number eleven. `A-Eleven-Y` is a widely used shorthand for | ||
`accessibility`. | ||
Note that the `11` is the number eleven. `A-Eleven-Y` is a widely used shorthand for `accessibility`. | ||
## Usage | ||
Import the `setStatus` function from this library and then use the function to set the desired | ||
status in your code. | ||
Import the `setStatus` function from this library and then use the function to set the desired status in your code. | ||
@@ -36,4 +31,4 @@ ```ts | ||
const button = document.getElementById('insert-selection'); | ||
const select = document.getElementById('selection'); | ||
const button = document.querySelector('#insert-selection'); | ||
const select = document.querySelector('#selection'); | ||
@@ -50,3 +45,2 @@ button.addEventListener('click', (event) => { | ||
This code was taken from | ||
[downshift](https://github.com/downshift-js/downshift/blob/master/src/set-a11y-status.js) | ||
This code was taken from [downshift](https://github.com/downshift-js/downshift/blob/master/src/set-a11y-status.js) |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
13647
44