aria-ease 1.5.2 → 1.5.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@ Out of the box accessibility utility package to develop production ready applica
|
|
|
12
12
|
|
|
13
13
|
Don't spend hours wrestling with accessibility code. Aria-Ease provides pre-built functions that help you integrate accessibility seamlessly into your development workflow. It simplifies the process of adding essential accessibility features (e.g. assistive capability, keyboard navigation, focus management) to common UI components like menus, accordions, checkboxes, e.t.c. This allows you to focus on building great user experiences for everyone.
|
|
14
14
|
|
|
15
|
-
The package currently has support for
|
|
15
|
+
The package currently has support for 6 components: accordions, blocks, checkboxes, menus, radios, toggle butttons.
|
|
16
16
|
|
|
17
17
|
Add accessibility to menu: menu can be a dropdown, combo box, slide navigation menu, e.t.c. Basically any component that toggles display and has a list of interactive children items. The function creates a focus trap within the menu and focus can be navigated using the arrow keys. The escape key also closes the menu and returns the focus back to the trigger.
|
|
18
18
|
|
|
@@ -99,7 +99,7 @@ const MenuExample = () => {
|
|
|
99
99
|
export default MenuExample;
|
|
100
100
|
```
|
|
101
101
|
|
|
102
|
-
Add accessibility to block: block can be tabs, entire web page body, interactive sliders and carousels e.t.c. Basically any 'block' component that is permanently displayed and has a list of related interactive children items. The function creates a focus trap within the block and the focus can be navigated using the arrow keys. Using the entire page as a block, the page serves as a focus trap, and the page can be navigated from one interactive item to another from the top of the page to the bottom and
|
|
102
|
+
Add accessibility to block: block can be tabs, entire web page body, interactive sliders and carousels e.t.c. Basically any 'block' component that is permanently displayed and has a list of related interactive children items. The function creates a focus trap within the block and the focus can be navigated using the arrow keys. Using the entire page as a block, the page serves as a focus trap, and the page can be navigated from one interactive item to another from the top of the page to the bottom and cycles back to the top.
|
|
103
103
|
|
|
104
104
|
The makeBlockAccessible function takes two string arguments; the id of the block main div, and the class name of the children items of the div. The function should be called on page render, so the event listeners get activated. On click of a button, the clicked button gets focused and the focus can be navigated using the arrow keys.
|
|
105
105
|
|
|
@@ -132,7 +132,7 @@ const BlockExample = () => {
|
|
|
132
132
|
export default BlockExample;
|
|
133
133
|
```
|
|
134
134
|
|
|
135
|
-
[Check out more features/functionality in the docs](https://
|
|
135
|
+
[Check out more features/functionality in the docs](https://ariaease.xyz/docs)
|
|
136
136
|
|
|
137
137
|
[Start contributing on GitHub](https://github.com/aria-ease/aria-ease)
|
|
138
138
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "aria-ease",
|
|
3
|
-
"version": "1.5.
|
|
3
|
+
"version": "1.5.4",
|
|
4
4
|
"description": "Out-of-the-box accessibility utility package to develop production ready applications.",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -25,6 +25,6 @@
|
|
|
25
25
|
"bugs": {
|
|
26
26
|
"url": "https://github.com/aria-ease/aria-ease/issues"
|
|
27
27
|
},
|
|
28
|
-
"homepage": "https://
|
|
28
|
+
"homepage": "https://ariaease.xyz/docs",
|
|
29
29
|
"types": "./aria-ease.d.ts"
|
|
30
30
|
}
|