accessibility-plugin-react 1.0.0
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 +69 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.es.js +8354 -0
- package/dist/index.umd.js +14 -0
- package/package.json +63 -0
package/README.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# Accessibility Plugin
|
|
2
|
+
|
|
3
|
+
A customizable, accessible, and easy-to-integrate React accessibility widget.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Contrast & Color Modes**: Invert, Grayscale, Low/High Saturation, Yellow on Black, White on Black, Blue on Yellow.
|
|
8
|
+
- **Text Adjustments**: Font Size, Line Height, Letter Spacing, Text Alignment.
|
|
9
|
+
- **Cursor Enhancements**: Big Cursor, Reading Guide.
|
|
10
|
+
- **Visual Toggles**: Hide Images, Highlight Links.
|
|
11
|
+
- **Drag & Drop**: Draggable trigger button.
|
|
12
|
+
- **Persistence**: Settings are saved in local storage (implementation pending/optional).
|
|
13
|
+
- **Reset**: Easily reset all settings to default.
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install accessibility-plugin
|
|
19
|
+
# or
|
|
20
|
+
yarn add accessibility-plugin
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
(Note: Replace `accessibility-plugin` with the actual package name if different when published).
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
Wrap your application (or the part you want to be accessible) with the `AccessibilityPlugin` component.
|
|
28
|
+
|
|
29
|
+
```tsx
|
|
30
|
+
import { AccessibilityPlugin } from 'accessibility-plugin';
|
|
31
|
+
import 'accessibility-plugin/dist/style.css'; // Import styles
|
|
32
|
+
|
|
33
|
+
function App() {
|
|
34
|
+
return (
|
|
35
|
+
<AccessibilityPlugin>
|
|
36
|
+
<YourAppContent />
|
|
37
|
+
</AccessibilityPlugin>
|
|
38
|
+
);
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
export default App;
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Custom Trigger
|
|
45
|
+
|
|
46
|
+
You can provide a custom trigger button if you don't want to use the default one.
|
|
47
|
+
|
|
48
|
+
```tsx
|
|
49
|
+
<AccessibilityPlugin
|
|
50
|
+
trigger={
|
|
51
|
+
<button className="px-4 py-2 bg-blue-600 text-white rounded">
|
|
52
|
+
Open Accessibility
|
|
53
|
+
</button>
|
|
54
|
+
}
|
|
55
|
+
>
|
|
56
|
+
<YourAppContent />
|
|
57
|
+
</AccessibilityPlugin>
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Development
|
|
61
|
+
|
|
62
|
+
1. Clone the repository.
|
|
63
|
+
2. Install dependencies: `npm install`.
|
|
64
|
+
3. Run the development server: `npm run dev`.
|
|
65
|
+
4. Build the package: `npm run build`.
|
|
66
|
+
|
|
67
|
+
## License
|
|
68
|
+
|
|
69
|
+
MIT
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {}
|