@a11y-core/react 0.1.0-alpha.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 +252 -0
- package/dist/chunk-3WBTHTVK.js +41 -0
- package/dist/chunk-3WBTHTVK.js.map +1 -0
- package/dist/chunk-47MFBHV6.js +85 -0
- package/dist/chunk-47MFBHV6.js.map +1 -0
- package/dist/chunk-7A3IDIUB.cjs +89 -0
- package/dist/chunk-7A3IDIUB.cjs.map +1 -0
- package/dist/chunk-AZFZWGI6.cjs +383 -0
- package/dist/chunk-AZFZWGI6.cjs.map +1 -0
- package/dist/chunk-CTW5D77X.cjs +220 -0
- package/dist/chunk-CTW5D77X.cjs.map +1 -0
- package/dist/chunk-EY73HQNR.js +380 -0
- package/dist/chunk-EY73HQNR.js.map +1 -0
- package/dist/chunk-FJABCNFE.js +215 -0
- package/dist/chunk-FJABCNFE.js.map +1 -0
- package/dist/chunk-FTZ5KCOO.js +326 -0
- package/dist/chunk-FTZ5KCOO.js.map +1 -0
- package/dist/chunk-GS3H4T2O.cjs +106 -0
- package/dist/chunk-GS3H4T2O.cjs.map +1 -0
- package/dist/chunk-N6L4GLFC.cjs +45 -0
- package/dist/chunk-N6L4GLFC.cjs.map +1 -0
- package/dist/chunk-N774QCHE.js +234 -0
- package/dist/chunk-N774QCHE.js.map +1 -0
- package/dist/chunk-OSHIYZCZ.cjs +386 -0
- package/dist/chunk-OSHIYZCZ.cjs.map +1 -0
- package/dist/chunk-SRJSGDIA.js +373 -0
- package/dist/chunk-SRJSGDIA.js.map +1 -0
- package/dist/chunk-THB5U7YC.cjs +338 -0
- package/dist/chunk-THB5U7YC.cjs.map +1 -0
- package/dist/chunk-U6DUSMEA.js +99 -0
- package/dist/chunk-U6DUSMEA.js.map +1 -0
- package/dist/chunk-WDCYEMBO.cjs +245 -0
- package/dist/chunk-WDCYEMBO.cjs.map +1 -0
- package/dist/components/combobox/index.cjs +31 -0
- package/dist/components/combobox/index.cjs.map +1 -0
- package/dist/components/combobox/index.d.cts +55 -0
- package/dist/components/combobox/index.d.ts +55 -0
- package/dist/components/combobox/index.js +6 -0
- package/dist/components/combobox/index.js.map +1 -0
- package/dist/components/dialog/index.cjs +46 -0
- package/dist/components/dialog/index.cjs.map +1 -0
- package/dist/components/dialog/index.d.cts +84 -0
- package/dist/components/dialog/index.d.ts +84 -0
- package/dist/components/dialog/index.js +5 -0
- package/dist/components/dialog/index.js.map +1 -0
- package/dist/components/menu/index.cjs +46 -0
- package/dist/components/menu/index.cjs.map +1 -0
- package/dist/components/menu/index.d.cts +80 -0
- package/dist/components/menu/index.d.ts +80 -0
- package/dist/components/menu/index.js +5 -0
- package/dist/components/menu/index.js.map +1 -0
- package/dist/components/tabs/index.cjs +35 -0
- package/dist/components/tabs/index.cjs.map +1 -0
- package/dist/components/tabs/index.d.cts +65 -0
- package/dist/components/tabs/index.d.ts +65 -0
- package/dist/components/tabs/index.js +6 -0
- package/dist/components/tabs/index.js.map +1 -0
- package/dist/components/toast/index.cjs +24 -0
- package/dist/components/toast/index.cjs.map +1 -0
- package/dist/components/toast/index.d.cts +49 -0
- package/dist/components/toast/index.d.ts +49 -0
- package/dist/components/toast/index.js +3 -0
- package/dist/components/toast/index.js.map +1 -0
- package/dist/index.cjs +698 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +402 -0
- package/dist/index.d.ts +402 -0
- package/dist/index.js +426 -0
- package/dist/index.js.map +1 -0
- package/package.json +89 -0
package/README.md
ADDED
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
# @a11y-core/react
|
|
2
|
+
|
|
3
|
+
Accessible React components that just work.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @a11y-core/react
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Components
|
|
12
|
+
|
|
13
|
+
### Dialog
|
|
14
|
+
|
|
15
|
+
```tsx
|
|
16
|
+
import { Dialog } from '@a11y-core/react';
|
|
17
|
+
|
|
18
|
+
function ConfirmDialog({ open, onClose, onConfirm }) {
|
|
19
|
+
return (
|
|
20
|
+
<Dialog open={open} onOpenChange={onClose}>
|
|
21
|
+
<Dialog.Title>Confirm Delete</Dialog.Title>
|
|
22
|
+
<Dialog.Description>
|
|
23
|
+
Are you sure you want to delete this item?
|
|
24
|
+
</Dialog.Description>
|
|
25
|
+
<Dialog.Actions>
|
|
26
|
+
<button onClick={onClose}>Cancel</button>
|
|
27
|
+
<button onClick={onConfirm}>Delete</button>
|
|
28
|
+
</Dialog.Actions>
|
|
29
|
+
</Dialog>
|
|
30
|
+
);
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Menu
|
|
35
|
+
|
|
36
|
+
```tsx
|
|
37
|
+
import { Menu } from '@a11y-core/react';
|
|
38
|
+
|
|
39
|
+
function ActionMenu() {
|
|
40
|
+
return (
|
|
41
|
+
<Menu>
|
|
42
|
+
<Menu.Trigger>Actions</Menu.Trigger>
|
|
43
|
+
<Menu.Content>
|
|
44
|
+
<Menu.Item onSelect={() => console.log('Edit')}>Edit</Menu.Item>
|
|
45
|
+
<Menu.Item onSelect={() => console.log('Copy')}>Copy</Menu.Item>
|
|
46
|
+
<Menu.Separator />
|
|
47
|
+
<Menu.Item onSelect={() => console.log('Delete')}>Delete</Menu.Item>
|
|
48
|
+
</Menu.Content>
|
|
49
|
+
</Menu>
|
|
50
|
+
);
|
|
51
|
+
}
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Tabs
|
|
55
|
+
|
|
56
|
+
```tsx
|
|
57
|
+
import { Tabs } from '@a11y-core/react';
|
|
58
|
+
|
|
59
|
+
function SettingsTabs() {
|
|
60
|
+
return (
|
|
61
|
+
<Tabs defaultValue="general">
|
|
62
|
+
<Tabs.List>
|
|
63
|
+
<Tabs.Tab value="general">General</Tabs.Tab>
|
|
64
|
+
<Tabs.Tab value="security">Security</Tabs.Tab>
|
|
65
|
+
<Tabs.Tab value="notifications">Notifications</Tabs.Tab>
|
|
66
|
+
</Tabs.List>
|
|
67
|
+
<Tabs.Panel value="general">General settings...</Tabs.Panel>
|
|
68
|
+
<Tabs.Panel value="security">Security settings...</Tabs.Panel>
|
|
69
|
+
<Tabs.Panel value="notifications">Notification settings...</Tabs.Panel>
|
|
70
|
+
</Tabs>
|
|
71
|
+
);
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Toast
|
|
76
|
+
|
|
77
|
+
```tsx
|
|
78
|
+
import {
|
|
79
|
+
ToastProvider,
|
|
80
|
+
ToastViewport,
|
|
81
|
+
useToastHelpers,
|
|
82
|
+
} from '@a11y-core/react';
|
|
83
|
+
|
|
84
|
+
function App() {
|
|
85
|
+
return (
|
|
86
|
+
<ToastProvider>
|
|
87
|
+
<Content />
|
|
88
|
+
<ToastViewport position="bottom-right" />
|
|
89
|
+
</ToastProvider>
|
|
90
|
+
);
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
function Content() {
|
|
94
|
+
const { success, error } = useToastHelpers();
|
|
95
|
+
|
|
96
|
+
return <button onClick={() => success('Settings saved!')}>Save</button>;
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Combobox
|
|
101
|
+
|
|
102
|
+
```tsx
|
|
103
|
+
import { Combobox } from '@a11y-core/react';
|
|
104
|
+
|
|
105
|
+
const countries = [
|
|
106
|
+
{ value: 'us', label: 'United States' },
|
|
107
|
+
{ value: 'uk', label: 'United Kingdom' },
|
|
108
|
+
{ value: 'ca', label: 'Canada' },
|
|
109
|
+
];
|
|
110
|
+
|
|
111
|
+
function CountrySelect() {
|
|
112
|
+
const [value, setValue] = useState(null);
|
|
113
|
+
|
|
114
|
+
return (
|
|
115
|
+
<Combobox
|
|
116
|
+
options={countries}
|
|
117
|
+
value={value}
|
|
118
|
+
onValueChange={setValue}
|
|
119
|
+
aria-label="Select country"
|
|
120
|
+
>
|
|
121
|
+
<Combobox.Input placeholder="Choose a country..." clearable />
|
|
122
|
+
<Combobox.Listbox emptyMessage="No countries found" />
|
|
123
|
+
</Combobox>
|
|
124
|
+
);
|
|
125
|
+
}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## Hooks
|
|
129
|
+
|
|
130
|
+
### useFocusTrap
|
|
131
|
+
|
|
132
|
+
```tsx
|
|
133
|
+
import { useFocusTrap } from '@a11y-core/react';
|
|
134
|
+
|
|
135
|
+
function Modal({ isOpen }) {
|
|
136
|
+
const trapRef = useFocusTrap({ active: isOpen });
|
|
137
|
+
|
|
138
|
+
return (
|
|
139
|
+
<div ref={trapRef} role="dialog">
|
|
140
|
+
<button>Close</button>
|
|
141
|
+
</div>
|
|
142
|
+
);
|
|
143
|
+
}
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### useAnnouncer
|
|
147
|
+
|
|
148
|
+
```tsx
|
|
149
|
+
import { useAnnouncer } from '@a11y-core/react';
|
|
150
|
+
|
|
151
|
+
function SearchResults({ count }) {
|
|
152
|
+
const { announce } = useAnnouncer();
|
|
153
|
+
|
|
154
|
+
useEffect(() => {
|
|
155
|
+
announce(`Found ${count} results`);
|
|
156
|
+
}, [count, announce]);
|
|
157
|
+
}
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### useKeyboard
|
|
161
|
+
|
|
162
|
+
```tsx
|
|
163
|
+
import { useKeyboard } from '@a11y-core/react';
|
|
164
|
+
|
|
165
|
+
function CustomList() {
|
|
166
|
+
const keyboardProps = useKeyboard({
|
|
167
|
+
ArrowDown: () => focusNext(),
|
|
168
|
+
ArrowUp: () => focusPrevious(),
|
|
169
|
+
Enter: () => selectItem(),
|
|
170
|
+
});
|
|
171
|
+
|
|
172
|
+
return <ul {...keyboardProps}>...</ul>;
|
|
173
|
+
}
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### useFocusVisible
|
|
177
|
+
|
|
178
|
+
```tsx
|
|
179
|
+
import { useFocusVisible } from '@a11y-core/react';
|
|
180
|
+
|
|
181
|
+
function Button({ children }) {
|
|
182
|
+
const { isFocusVisible, focusProps } = useFocusVisible();
|
|
183
|
+
|
|
184
|
+
return (
|
|
185
|
+
<button {...focusProps} className={isFocusVisible ? 'focus-ring' : ''}>
|
|
186
|
+
{children}
|
|
187
|
+
</button>
|
|
188
|
+
);
|
|
189
|
+
}
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### useRovingTabindex
|
|
193
|
+
|
|
194
|
+
```tsx
|
|
195
|
+
import { useRovingTabindex } from '@a11y-core/react';
|
|
196
|
+
|
|
197
|
+
function Toolbar() {
|
|
198
|
+
const { getItemProps } = useRovingTabindex({
|
|
199
|
+
itemCount: 3,
|
|
200
|
+
orientation: 'horizontal',
|
|
201
|
+
});
|
|
202
|
+
|
|
203
|
+
return (
|
|
204
|
+
<div role="toolbar">
|
|
205
|
+
<button {...getItemProps(0)}>Cut</button>
|
|
206
|
+
<button {...getItemProps(1)}>Copy</button>
|
|
207
|
+
<button {...getItemProps(2)}>Paste</button>
|
|
208
|
+
</div>
|
|
209
|
+
);
|
|
210
|
+
}
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
## Styling
|
|
214
|
+
|
|
215
|
+
All components are unstyled. Use `data-*` attributes for state-based styling:
|
|
216
|
+
|
|
217
|
+
```css
|
|
218
|
+
/* Dialog */
|
|
219
|
+
[data-a11y-core-dialog-overlay] {
|
|
220
|
+
background: rgba(0, 0, 0, 0.5);
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
[data-a11y-core-dialog] {
|
|
224
|
+
background: white;
|
|
225
|
+
padding: 1.5rem;
|
|
226
|
+
border-radius: 8px;
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
/* Menu */
|
|
230
|
+
[data-a11y-core-menu-content] {
|
|
231
|
+
background: white;
|
|
232
|
+
border: 1px solid #e0e0e0;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
[data-a11y-core-menu-item][data-highlighted='true'] {
|
|
236
|
+
background: #f0f0f0;
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
/* Tabs */
|
|
240
|
+
[data-a11y-core-tab][data-selected='true'] {
|
|
241
|
+
border-bottom: 2px solid blue;
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
/* Combobox */
|
|
245
|
+
[data-a11y-core-combobox-option][data-highlighted='true'] {
|
|
246
|
+
background: #f0f0f0;
|
|
247
|
+
}
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
## License
|
|
251
|
+
|
|
252
|
+
MIT
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { useId as useId$1, useMemo } from 'react';
|
|
2
|
+
|
|
3
|
+
// src/hooks/use-id.ts
|
|
4
|
+
function useId(prefix) {
|
|
5
|
+
const reactId = useId$1();
|
|
6
|
+
return useMemo(() => {
|
|
7
|
+
const cleanId = reactId.replace(/:/g, "");
|
|
8
|
+
return prefix ? `a11y-core-${prefix}-${cleanId}` : `a11y-core-${cleanId}`;
|
|
9
|
+
}, [reactId, prefix]);
|
|
10
|
+
}
|
|
11
|
+
function useIds(parts, prefix) {
|
|
12
|
+
const baseId = useId(prefix);
|
|
13
|
+
return useMemo(() => {
|
|
14
|
+
const ids = {};
|
|
15
|
+
for (const part of parts) {
|
|
16
|
+
ids[part] = `${baseId}-${part}`;
|
|
17
|
+
}
|
|
18
|
+
return ids;
|
|
19
|
+
}, [baseId, parts]);
|
|
20
|
+
}
|
|
21
|
+
function useIdScope(componentName) {
|
|
22
|
+
const scopeId = useId(componentName);
|
|
23
|
+
return useMemo(
|
|
24
|
+
() => ({
|
|
25
|
+
id: scopeId,
|
|
26
|
+
generate: (suffix) => `${scopeId}-${suffix}`,
|
|
27
|
+
generateMultiple: (parts) => {
|
|
28
|
+
const ids = {};
|
|
29
|
+
for (const part of parts) {
|
|
30
|
+
ids[part] = `${scopeId}-${part}`;
|
|
31
|
+
}
|
|
32
|
+
return ids;
|
|
33
|
+
}
|
|
34
|
+
}),
|
|
35
|
+
[scopeId]
|
|
36
|
+
);
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export { useId, useIdScope, useIds };
|
|
40
|
+
//# sourceMappingURL=chunk-3WBTHTVK.js.map
|
|
41
|
+
//# sourceMappingURL=chunk-3WBTHTVK.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/hooks/use-id.ts"],"names":["useReactId"],"mappings":";;;AAOO,SAAS,MAAM,MAAA,EAAyB;AAE7C,EAAA,MAAM,UAAUA,OAAA,EAAW;AAE3B,EAAA,OAAO,QAAQ,MAAM;AAEnB,IAAA,MAAM,OAAA,GAAU,OAAA,CAAQ,OAAA,CAAQ,IAAA,EAAM,EAAE,CAAA;AACxC,IAAA,OAAO,SAAS,CAAA,UAAA,EAAa,MAAM,IAAI,OAAO,CAAA,CAAA,GAAK,aAAa,OAAO,CAAA,CAAA;AAAA,EACzE,CAAA,EAAG,CAAC,OAAA,EAAS,MAAM,CAAC,CAAA;AACtB;AAKO,SAAS,MAAA,CACd,OACA,MAAA,EAC2B;AAC3B,EAAA,MAAM,MAAA,GAAS,MAAM,MAAM,CAAA;AAE3B,EAAA,OAAO,QAAQ,MAAM;AACnB,IAAA,MAAM,MAAM,EAAC;AACb,IAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACxB,MAAA,GAAA,CAAI,IAAI,CAAA,GAAI,CAAA,EAAG,MAAM,IAAI,IAAI,CAAA,CAAA;AAAA,IAC/B;AACA,IAAA,OAAO,GAAA;AAAA,EACT,CAAA,EAAG,CAAC,MAAA,EAAQ,KAAK,CAAC,CAAA;AACpB;AAKO,SAAS,WAAW,aAAA,EAAuB;AAChD,EAAA,MAAM,OAAA,GAAU,MAAM,aAAa,CAAA;AAEnC,EAAA,OAAO,OAAA;AAAA,IACL,OAAO;AAAA,MACL,EAAA,EAAI,OAAA;AAAA,MACJ,UAAU,CAAC,MAAA,KAAmB,CAAA,EAAG,OAAO,IAAI,MAAM,CAAA,CAAA;AAAA,MAClD,gBAAA,EAAkB,CAA8B,KAAA,KAAa;AAC3D,QAAA,MAAM,MAAM,EAAC;AACb,QAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACxB,UAAA,GAAA,CAAI,IAAI,CAAA,GAAI,CAAA,EAAG,OAAO,IAAI,IAAI,CAAA,CAAA;AAAA,QAChC;AACA,QAAA,OAAO,GAAA;AAAA,MACT;AAAA,KACF,CAAA;AAAA,IACA,CAAC,OAAO;AAAA,GACV;AACF","file":"chunk-3WBTHTVK.js","sourcesContent":["import { useId as useReactId, useMemo } from 'react';\n\n/**\n * Generate a unique ID for accessibility purposes\n *\n * Uses React's useId when available, with a fallback for SSR\n */\nexport function useId(prefix?: string): string {\n // Use React 18's useId as the base\n const reactId = useReactId();\n\n return useMemo(() => {\n // Clean up React's ID format (removes colons)\n const cleanId = reactId.replace(/:/g, '');\n return prefix ? `a11y-core-${prefix}-${cleanId}` : `a11y-core-${cleanId}`;\n }, [reactId, prefix]);\n}\n\n/**\n * Generate multiple related IDs for a component\n */\nexport function useIds<T extends readonly string[]>(\n parts: T,\n prefix?: string\n): Record<T[number], string> {\n const baseId = useId(prefix);\n\n return useMemo(() => {\n const ids = {} as Record<string, string>;\n for (const part of parts) {\n ids[part] = `${baseId}-${part}`;\n }\n return ids as Record<T[number], string>;\n }, [baseId, parts]);\n}\n\n/**\n * Create a scoped ID generator for complex components\n */\nexport function useIdScope(componentName: string) {\n const scopeId = useId(componentName);\n\n return useMemo(\n () => ({\n id: scopeId,\n generate: (suffix: string) => `${scopeId}-${suffix}`,\n generateMultiple: <T extends readonly string[]>(parts: T) => {\n const ids = {} as Record<string, string>;\n for (const part of parts) {\n ids[part] = `${scopeId}-${part}`;\n }\n return ids as Record<T[number], string>;\n },\n }),\n [scopeId]\n );\n}\n"]}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { useEffect, useCallback, useRef } from 'react';
|
|
2
|
+
import { initAnnouncer, announce, announcePolite, announceAssertive, queueAnnouncement, clearAnnouncements } from '@a11y-core/core';
|
|
3
|
+
|
|
4
|
+
// src/hooks/use-announcer.ts
|
|
5
|
+
function useAnnouncer() {
|
|
6
|
+
useEffect(() => {
|
|
7
|
+
const cleanup = initAnnouncer();
|
|
8
|
+
return cleanup;
|
|
9
|
+
}, []);
|
|
10
|
+
const announceMessage = useCallback(
|
|
11
|
+
(message, options) => {
|
|
12
|
+
announce(message, options);
|
|
13
|
+
},
|
|
14
|
+
[]
|
|
15
|
+
);
|
|
16
|
+
const polite = useCallback(
|
|
17
|
+
(message, options) => {
|
|
18
|
+
announcePolite(message, options);
|
|
19
|
+
},
|
|
20
|
+
[]
|
|
21
|
+
);
|
|
22
|
+
const assertive = useCallback(
|
|
23
|
+
(message, options) => {
|
|
24
|
+
announceAssertive(message, options);
|
|
25
|
+
},
|
|
26
|
+
[]
|
|
27
|
+
);
|
|
28
|
+
const queue = useCallback(
|
|
29
|
+
(message, options) => {
|
|
30
|
+
queueAnnouncement(message, options);
|
|
31
|
+
},
|
|
32
|
+
[]
|
|
33
|
+
);
|
|
34
|
+
const clear = useCallback(() => {
|
|
35
|
+
clearAnnouncements();
|
|
36
|
+
}, []);
|
|
37
|
+
return {
|
|
38
|
+
announce: announceMessage,
|
|
39
|
+
polite,
|
|
40
|
+
assertive,
|
|
41
|
+
queue,
|
|
42
|
+
clear
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
function useAnnounceOnChange(value, getMessage, options) {
|
|
46
|
+
const { skipInitial = true, ...announceOptions } = options ?? {};
|
|
47
|
+
const isFirstRender = useRef(true);
|
|
48
|
+
const previousValue = useRef(value);
|
|
49
|
+
useEffect(() => {
|
|
50
|
+
if (isFirstRender.current && skipInitial) {
|
|
51
|
+
isFirstRender.current = false;
|
|
52
|
+
previousValue.current = value;
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
if (previousValue.current !== value) {
|
|
56
|
+
announce(getMessage(value), announceOptions);
|
|
57
|
+
previousValue.current = value;
|
|
58
|
+
}
|
|
59
|
+
}, [value, getMessage, announceOptions]);
|
|
60
|
+
}
|
|
61
|
+
function useAnnounceLoading(isLoading, options = {}) {
|
|
62
|
+
const {
|
|
63
|
+
loadingMessage = "Loading...",
|
|
64
|
+
loadedMessage = "Content loaded",
|
|
65
|
+
errorMessage = "An error occurred",
|
|
66
|
+
error
|
|
67
|
+
} = options;
|
|
68
|
+
const wasLoading = useRef(false);
|
|
69
|
+
useEffect(() => {
|
|
70
|
+
if (isLoading && !wasLoading.current) {
|
|
71
|
+
announcePolite(loadingMessage);
|
|
72
|
+
} else if (!isLoading && wasLoading.current) {
|
|
73
|
+
if (error) {
|
|
74
|
+
announceAssertive(errorMessage);
|
|
75
|
+
} else {
|
|
76
|
+
announcePolite(loadedMessage);
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
wasLoading.current = isLoading;
|
|
80
|
+
}, [isLoading, error, loadingMessage, loadedMessage, errorMessage]);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export { useAnnounceLoading, useAnnounceOnChange, useAnnouncer };
|
|
84
|
+
//# sourceMappingURL=chunk-47MFBHV6.js.map
|
|
85
|
+
//# sourceMappingURL=chunk-47MFBHV6.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/hooks/use-announcer.ts"],"names":[],"mappings":";;;;AA2BO,SAAS,YAAA,GAAe;AAE7B,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,MAAM,UAAU,aAAA,EAAc;AAC9B,IAAA,OAAO,OAAA;AAAA,EACT,CAAA,EAAG,EAAE,CAAA;AAEL,EAAA,MAAM,eAAA,GAAkB,WAAA;AAAA,IACtB,CAAC,SAAiB,OAAA,KAA+B;AAC/C,MAAA,QAAA,CAAS,SAAS,OAAO,CAAA;AAAA,IAC3B,CAAA;AAAA,IACA;AAAC,GACH;AAEA,EAAA,MAAM,MAAA,GAAS,WAAA;AAAA,IACb,CAAC,SAAiB,OAAA,KAAmD;AACnE,MAAA,cAAA,CAAe,SAAS,OAAO,CAAA;AAAA,IACjC,CAAA;AAAA,IACA;AAAC,GACH;AAEA,EAAA,MAAM,SAAA,GAAY,WAAA;AAAA,IAChB,CAAC,SAAiB,OAAA,KAAmD;AACnE,MAAA,iBAAA,CAAkB,SAAS,OAAO,CAAA;AAAA,IACpC,CAAA;AAAA,IACA;AAAC,GACH;AAEA,EAAA,MAAM,KAAA,GAAQ,WAAA;AAAA,IACZ,CAAC,SAAiB,OAAA,KAAuD;AACvE,MAAA,iBAAA,CAAkB,SAAS,OAAO,CAAA;AAAA,IACpC,CAAA;AAAA,IACA;AAAC,GACH;AAEA,EAAA,MAAM,KAAA,GAAQ,YAAY,MAAM;AAC9B,IAAA,kBAAA,EAAmB;AAAA,EACrB,CAAA,EAAG,EAAE,CAAA;AAEL,EAAA,OAAO;AAAA,IACL,QAAA,EAAU,eAAA;AAAA,IACV,MAAA;AAAA,IACA,SAAA;AAAA,IACA,KAAA;AAAA,IACA;AAAA,GACF;AACF;AAaO,SAAS,mBAAA,CACd,KAAA,EACA,UAAA,EACA,OAAA,EACM;AACN,EAAA,MAAM,EAAE,WAAA,GAAc,IAAA,EAAM,GAAG,eAAA,EAAgB,GAAI,WAAW,EAAC;AAC/D,EAAA,MAAM,aAAA,GAAgB,OAAO,IAAI,CAAA;AACjC,EAAA,MAAM,aAAA,GAAgB,OAAO,KAAK,CAAA;AAElC,EAAA,SAAA,CAAU,MAAM;AAEd,IAAA,IAAI,aAAA,CAAc,WAAW,WAAA,EAAa;AACxC,MAAA,aAAA,CAAc,OAAA,GAAU,KAAA;AACxB,MAAA,aAAA,CAAc,OAAA,GAAU,KAAA;AACxB,MAAA;AAAA,IACF;AAGA,IAAA,IAAI,aAAA,CAAc,YAAY,KAAA,EAAO;AACnC,MAAA,QAAA,CAAS,UAAA,CAAW,KAAK,CAAA,EAAG,eAAe,CAAA;AAC3C,MAAA,aAAA,CAAc,OAAA,GAAU,KAAA;AAAA,IAC1B;AAAA,EACF,CAAA,EAAG,CAAC,KAAA,EAAO,UAAA,EAAY,eAAe,CAAC,CAAA;AACzC;AAiBO,SAAS,kBAAA,CACd,SAAA,EACA,OAAA,GAKI,EAAC,EACC;AACN,EAAA,MAAM;AAAA,IACJ,cAAA,GAAiB,YAAA;AAAA,IACjB,aAAA,GAAgB,gBAAA;AAAA,IAChB,YAAA,GAAe,mBAAA;AAAA,IACf;AAAA,GACF,GAAI,OAAA;AAEJ,EAAA,MAAM,UAAA,GAAa,OAAO,KAAK,CAAA;AAE/B,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,SAAA,IAAa,CAAC,UAAA,CAAW,OAAA,EAAS;AACpC,MAAA,cAAA,CAAe,cAAc,CAAA;AAAA,IAC/B,CAAA,MAAA,IAAW,CAAC,SAAA,IAAa,UAAA,CAAW,OAAA,EAAS;AAC3C,MAAA,IAAI,KAAA,EAAO;AACT,QAAA,iBAAA,CAAkB,YAAY,CAAA;AAAA,MAChC,CAAA,MAAO;AACL,QAAA,cAAA,CAAe,aAAa,CAAA;AAAA,MAC9B;AAAA,IACF;AACA,IAAA,UAAA,CAAW,OAAA,GAAU,SAAA;AAAA,EACvB,GAAG,CAAC,SAAA,EAAW,OAAO,cAAA,EAAgB,aAAA,EAAe,YAAY,CAAC,CAAA;AACpE","file":"chunk-47MFBHV6.js","sourcesContent":["import { useCallback, useEffect, useRef } from 'react';\nimport {\n announce,\n announcePolite,\n announceAssertive,\n queueAnnouncement,\n clearAnnouncements,\n initAnnouncer,\n type AnnouncerOptions,\n} from '@a11y-core/core';\n\n/**\n * Hook for screen reader announcements\n *\n * @example\n * ```tsx\n * function SearchResults({ results }) {\n * const { announce } = useAnnouncer();\n *\n * useEffect(() => {\n * announce(`Found ${results.length} results`);\n * }, [results.length, announce]);\n *\n * return <ul>...</ul>;\n * }\n * ```\n */\nexport function useAnnouncer() {\n // Ensure announcer is initialized\n useEffect(() => {\n const cleanup = initAnnouncer();\n return cleanup;\n }, []);\n\n const announceMessage = useCallback(\n (message: string, options?: AnnouncerOptions) => {\n announce(message, options);\n },\n []\n );\n\n const polite = useCallback(\n (message: string, options?: Omit<AnnouncerOptions, 'politeness'>) => {\n announcePolite(message, options);\n },\n []\n );\n\n const assertive = useCallback(\n (message: string, options?: Omit<AnnouncerOptions, 'politeness'>) => {\n announceAssertive(message, options);\n },\n []\n );\n\n const queue = useCallback(\n (message: string, options?: AnnouncerOptions & { debounce?: number }) => {\n queueAnnouncement(message, options);\n },\n []\n );\n\n const clear = useCallback(() => {\n clearAnnouncements();\n }, []);\n\n return {\n announce: announceMessage,\n polite,\n assertive,\n queue,\n clear,\n };\n}\n\n/**\n * Announce a message when a value changes\n *\n * @example\n * ```tsx\n * function Counter({ count }) {\n * useAnnounceOnChange(count, (value) => `Count is now ${value}`);\n * return <span>{count}</span>;\n * }\n * ```\n */\nexport function useAnnounceOnChange<T>(\n value: T,\n getMessage: (value: T) => string,\n options?: AnnouncerOptions & { skipInitial?: boolean }\n): void {\n const { skipInitial = true, ...announceOptions } = options ?? {};\n const isFirstRender = useRef(true);\n const previousValue = useRef(value);\n\n useEffect(() => {\n // Skip initial render if specified\n if (isFirstRender.current && skipInitial) {\n isFirstRender.current = false;\n previousValue.current = value;\n return;\n }\n\n // Only announce if value changed\n if (previousValue.current !== value) {\n announce(getMessage(value), announceOptions);\n previousValue.current = value;\n }\n }, [value, getMessage, announceOptions]);\n}\n\n/**\n * Announce loading states\n *\n * @example\n * ```tsx\n * function DataList({ isLoading }) {\n * useAnnounceLoading(isLoading, {\n * loadingMessage: 'Loading data...',\n * loadedMessage: 'Data loaded',\n * });\n *\n * return <div>...</div>;\n * }\n * ```\n */\nexport function useAnnounceLoading(\n isLoading: boolean,\n options: {\n loadingMessage?: string;\n loadedMessage?: string;\n errorMessage?: string;\n error?: Error | null;\n } = {}\n): void {\n const {\n loadingMessage = 'Loading...',\n loadedMessage = 'Content loaded',\n errorMessage = 'An error occurred',\n error,\n } = options;\n\n const wasLoading = useRef(false);\n\n useEffect(() => {\n if (isLoading && !wasLoading.current) {\n announcePolite(loadingMessage);\n } else if (!isLoading && wasLoading.current) {\n if (error) {\n announceAssertive(errorMessage);\n } else {\n announcePolite(loadedMessage);\n }\n }\n wasLoading.current = isLoading;\n }, [isLoading, error, loadingMessage, loadedMessage, errorMessage]);\n}\n"]}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var react = require('react');
|
|
4
|
+
var core = require('@a11y-core/core');
|
|
5
|
+
|
|
6
|
+
// src/hooks/use-announcer.ts
|
|
7
|
+
function useAnnouncer() {
|
|
8
|
+
react.useEffect(() => {
|
|
9
|
+
const cleanup = core.initAnnouncer();
|
|
10
|
+
return cleanup;
|
|
11
|
+
}, []);
|
|
12
|
+
const announceMessage = react.useCallback(
|
|
13
|
+
(message, options) => {
|
|
14
|
+
core.announce(message, options);
|
|
15
|
+
},
|
|
16
|
+
[]
|
|
17
|
+
);
|
|
18
|
+
const polite = react.useCallback(
|
|
19
|
+
(message, options) => {
|
|
20
|
+
core.announcePolite(message, options);
|
|
21
|
+
},
|
|
22
|
+
[]
|
|
23
|
+
);
|
|
24
|
+
const assertive = react.useCallback(
|
|
25
|
+
(message, options) => {
|
|
26
|
+
core.announceAssertive(message, options);
|
|
27
|
+
},
|
|
28
|
+
[]
|
|
29
|
+
);
|
|
30
|
+
const queue = react.useCallback(
|
|
31
|
+
(message, options) => {
|
|
32
|
+
core.queueAnnouncement(message, options);
|
|
33
|
+
},
|
|
34
|
+
[]
|
|
35
|
+
);
|
|
36
|
+
const clear = react.useCallback(() => {
|
|
37
|
+
core.clearAnnouncements();
|
|
38
|
+
}, []);
|
|
39
|
+
return {
|
|
40
|
+
announce: announceMessage,
|
|
41
|
+
polite,
|
|
42
|
+
assertive,
|
|
43
|
+
queue,
|
|
44
|
+
clear
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
function useAnnounceOnChange(value, getMessage, options) {
|
|
48
|
+
const { skipInitial = true, ...announceOptions } = options ?? {};
|
|
49
|
+
const isFirstRender = react.useRef(true);
|
|
50
|
+
const previousValue = react.useRef(value);
|
|
51
|
+
react.useEffect(() => {
|
|
52
|
+
if (isFirstRender.current && skipInitial) {
|
|
53
|
+
isFirstRender.current = false;
|
|
54
|
+
previousValue.current = value;
|
|
55
|
+
return;
|
|
56
|
+
}
|
|
57
|
+
if (previousValue.current !== value) {
|
|
58
|
+
core.announce(getMessage(value), announceOptions);
|
|
59
|
+
previousValue.current = value;
|
|
60
|
+
}
|
|
61
|
+
}, [value, getMessage, announceOptions]);
|
|
62
|
+
}
|
|
63
|
+
function useAnnounceLoading(isLoading, options = {}) {
|
|
64
|
+
const {
|
|
65
|
+
loadingMessage = "Loading...",
|
|
66
|
+
loadedMessage = "Content loaded",
|
|
67
|
+
errorMessage = "An error occurred",
|
|
68
|
+
error
|
|
69
|
+
} = options;
|
|
70
|
+
const wasLoading = react.useRef(false);
|
|
71
|
+
react.useEffect(() => {
|
|
72
|
+
if (isLoading && !wasLoading.current) {
|
|
73
|
+
core.announcePolite(loadingMessage);
|
|
74
|
+
} else if (!isLoading && wasLoading.current) {
|
|
75
|
+
if (error) {
|
|
76
|
+
core.announceAssertive(errorMessage);
|
|
77
|
+
} else {
|
|
78
|
+
core.announcePolite(loadedMessage);
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
wasLoading.current = isLoading;
|
|
82
|
+
}, [isLoading, error, loadingMessage, loadedMessage, errorMessage]);
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
exports.useAnnounceLoading = useAnnounceLoading;
|
|
86
|
+
exports.useAnnounceOnChange = useAnnounceOnChange;
|
|
87
|
+
exports.useAnnouncer = useAnnouncer;
|
|
88
|
+
//# sourceMappingURL=chunk-7A3IDIUB.cjs.map
|
|
89
|
+
//# sourceMappingURL=chunk-7A3IDIUB.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/hooks/use-announcer.ts"],"names":["useEffect","initAnnouncer","useCallback","announce","announcePolite","announceAssertive","queueAnnouncement","clearAnnouncements","useRef"],"mappings":";;;;;;AA2BO,SAAS,YAAA,GAAe;AAE7B,EAAAA,eAAA,CAAU,MAAM;AACd,IAAA,MAAM,UAAUC,kBAAA,EAAc;AAC9B,IAAA,OAAO,OAAA;AAAA,EACT,CAAA,EAAG,EAAE,CAAA;AAEL,EAAA,MAAM,eAAA,GAAkBC,iBAAA;AAAA,IACtB,CAAC,SAAiB,OAAA,KAA+B;AAC/C,MAAAC,aAAA,CAAS,SAAS,OAAO,CAAA;AAAA,IAC3B,CAAA;AAAA,IACA;AAAC,GACH;AAEA,EAAA,MAAM,MAAA,GAASD,iBAAA;AAAA,IACb,CAAC,SAAiB,OAAA,KAAmD;AACnE,MAAAE,mBAAA,CAAe,SAAS,OAAO,CAAA;AAAA,IACjC,CAAA;AAAA,IACA;AAAC,GACH;AAEA,EAAA,MAAM,SAAA,GAAYF,iBAAA;AAAA,IAChB,CAAC,SAAiB,OAAA,KAAmD;AACnE,MAAAG,sBAAA,CAAkB,SAAS,OAAO,CAAA;AAAA,IACpC,CAAA;AAAA,IACA;AAAC,GACH;AAEA,EAAA,MAAM,KAAA,GAAQH,iBAAA;AAAA,IACZ,CAAC,SAAiB,OAAA,KAAuD;AACvE,MAAAI,sBAAA,CAAkB,SAAS,OAAO,CAAA;AAAA,IACpC,CAAA;AAAA,IACA;AAAC,GACH;AAEA,EAAA,MAAM,KAAA,GAAQJ,kBAAY,MAAM;AAC9B,IAAAK,uBAAA,EAAmB;AAAA,EACrB,CAAA,EAAG,EAAE,CAAA;AAEL,EAAA,OAAO;AAAA,IACL,QAAA,EAAU,eAAA;AAAA,IACV,MAAA;AAAA,IACA,SAAA;AAAA,IACA,KAAA;AAAA,IACA;AAAA,GACF;AACF;AAaO,SAAS,mBAAA,CACd,KAAA,EACA,UAAA,EACA,OAAA,EACM;AACN,EAAA,MAAM,EAAE,WAAA,GAAc,IAAA,EAAM,GAAG,eAAA,EAAgB,GAAI,WAAW,EAAC;AAC/D,EAAA,MAAM,aAAA,GAAgBC,aAAO,IAAI,CAAA;AACjC,EAAA,MAAM,aAAA,GAAgBA,aAAO,KAAK,CAAA;AAElC,EAAAR,eAAA,CAAU,MAAM;AAEd,IAAA,IAAI,aAAA,CAAc,WAAW,WAAA,EAAa;AACxC,MAAA,aAAA,CAAc,OAAA,GAAU,KAAA;AACxB,MAAA,aAAA,CAAc,OAAA,GAAU,KAAA;AACxB,MAAA;AAAA,IACF;AAGA,IAAA,IAAI,aAAA,CAAc,YAAY,KAAA,EAAO;AACnC,MAAAG,aAAA,CAAS,UAAA,CAAW,KAAK,CAAA,EAAG,eAAe,CAAA;AAC3C,MAAA,aAAA,CAAc,OAAA,GAAU,KAAA;AAAA,IAC1B;AAAA,EACF,CAAA,EAAG,CAAC,KAAA,EAAO,UAAA,EAAY,eAAe,CAAC,CAAA;AACzC;AAiBO,SAAS,kBAAA,CACd,SAAA,EACA,OAAA,GAKI,EAAC,EACC;AACN,EAAA,MAAM;AAAA,IACJ,cAAA,GAAiB,YAAA;AAAA,IACjB,aAAA,GAAgB,gBAAA;AAAA,IAChB,YAAA,GAAe,mBAAA;AAAA,IACf;AAAA,GACF,GAAI,OAAA;AAEJ,EAAA,MAAM,UAAA,GAAaK,aAAO,KAAK,CAAA;AAE/B,EAAAR,eAAA,CAAU,MAAM;AACd,IAAA,IAAI,SAAA,IAAa,CAAC,UAAA,CAAW,OAAA,EAAS;AACpC,MAAAI,mBAAA,CAAe,cAAc,CAAA;AAAA,IAC/B,CAAA,MAAA,IAAW,CAAC,SAAA,IAAa,UAAA,CAAW,OAAA,EAAS;AAC3C,MAAA,IAAI,KAAA,EAAO;AACT,QAAAC,sBAAA,CAAkB,YAAY,CAAA;AAAA,MAChC,CAAA,MAAO;AACL,QAAAD,mBAAA,CAAe,aAAa,CAAA;AAAA,MAC9B;AAAA,IACF;AACA,IAAA,UAAA,CAAW,OAAA,GAAU,SAAA;AAAA,EACvB,GAAG,CAAC,SAAA,EAAW,OAAO,cAAA,EAAgB,aAAA,EAAe,YAAY,CAAC,CAAA;AACpE","file":"chunk-7A3IDIUB.cjs","sourcesContent":["import { useCallback, useEffect, useRef } from 'react';\nimport {\n announce,\n announcePolite,\n announceAssertive,\n queueAnnouncement,\n clearAnnouncements,\n initAnnouncer,\n type AnnouncerOptions,\n} from '@a11y-core/core';\n\n/**\n * Hook for screen reader announcements\n *\n * @example\n * ```tsx\n * function SearchResults({ results }) {\n * const { announce } = useAnnouncer();\n *\n * useEffect(() => {\n * announce(`Found ${results.length} results`);\n * }, [results.length, announce]);\n *\n * return <ul>...</ul>;\n * }\n * ```\n */\nexport function useAnnouncer() {\n // Ensure announcer is initialized\n useEffect(() => {\n const cleanup = initAnnouncer();\n return cleanup;\n }, []);\n\n const announceMessage = useCallback(\n (message: string, options?: AnnouncerOptions) => {\n announce(message, options);\n },\n []\n );\n\n const polite = useCallback(\n (message: string, options?: Omit<AnnouncerOptions, 'politeness'>) => {\n announcePolite(message, options);\n },\n []\n );\n\n const assertive = useCallback(\n (message: string, options?: Omit<AnnouncerOptions, 'politeness'>) => {\n announceAssertive(message, options);\n },\n []\n );\n\n const queue = useCallback(\n (message: string, options?: AnnouncerOptions & { debounce?: number }) => {\n queueAnnouncement(message, options);\n },\n []\n );\n\n const clear = useCallback(() => {\n clearAnnouncements();\n }, []);\n\n return {\n announce: announceMessage,\n polite,\n assertive,\n queue,\n clear,\n };\n}\n\n/**\n * Announce a message when a value changes\n *\n * @example\n * ```tsx\n * function Counter({ count }) {\n * useAnnounceOnChange(count, (value) => `Count is now ${value}`);\n * return <span>{count}</span>;\n * }\n * ```\n */\nexport function useAnnounceOnChange<T>(\n value: T,\n getMessage: (value: T) => string,\n options?: AnnouncerOptions & { skipInitial?: boolean }\n): void {\n const { skipInitial = true, ...announceOptions } = options ?? {};\n const isFirstRender = useRef(true);\n const previousValue = useRef(value);\n\n useEffect(() => {\n // Skip initial render if specified\n if (isFirstRender.current && skipInitial) {\n isFirstRender.current = false;\n previousValue.current = value;\n return;\n }\n\n // Only announce if value changed\n if (previousValue.current !== value) {\n announce(getMessage(value), announceOptions);\n previousValue.current = value;\n }\n }, [value, getMessage, announceOptions]);\n}\n\n/**\n * Announce loading states\n *\n * @example\n * ```tsx\n * function DataList({ isLoading }) {\n * useAnnounceLoading(isLoading, {\n * loadingMessage: 'Loading data...',\n * loadedMessage: 'Data loaded',\n * });\n *\n * return <div>...</div>;\n * }\n * ```\n */\nexport function useAnnounceLoading(\n isLoading: boolean,\n options: {\n loadingMessage?: string;\n loadedMessage?: string;\n errorMessage?: string;\n error?: Error | null;\n } = {}\n): void {\n const {\n loadingMessage = 'Loading...',\n loadedMessage = 'Content loaded',\n errorMessage = 'An error occurred',\n error,\n } = options;\n\n const wasLoading = useRef(false);\n\n useEffect(() => {\n if (isLoading && !wasLoading.current) {\n announcePolite(loadingMessage);\n } else if (!isLoading && wasLoading.current) {\n if (error) {\n announceAssertive(errorMessage);\n } else {\n announcePolite(loadedMessage);\n }\n }\n wasLoading.current = isLoading;\n }, [isLoading, error, loadingMessage, loadedMessage, errorMessage]);\n}\n"]}
|