@barqjs/aria 0.0.0-stage → 0.2.0-next.1

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.
Files changed (103) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +304 -2
  3. package/package.json +437 -4
  4. package/src/autocomplete.tsx +581 -0
  5. package/src/breadcrumbs.tsx +297 -0
  6. package/src/button.tsx +468 -0
  7. package/src/calendar.tsx +2316 -0
  8. package/src/checkbox.tsx +732 -0
  9. package/src/collections.ts +1059 -0
  10. package/src/color.ts +2119 -0
  11. package/src/colorpicker.tsx +2023 -0
  12. package/src/colorswatchpicker.tsx +240 -0
  13. package/src/combobox.tsx +3003 -0
  14. package/src/command.tsx +1203 -0
  15. package/src/date.ts +674 -0
  16. package/src/datefield.tsx +2066 -0
  17. package/src/datepicker.tsx +907 -0
  18. package/src/dialog.tsx +1077 -0
  19. package/src/disclosure.tsx +711 -0
  20. package/src/dnd/clipboard.ts +125 -0
  21. package/src/dnd/collection.ts +1265 -0
  22. package/src/dnd/data.ts +409 -0
  23. package/src/dnd/drag-drop.ts +801 -0
  24. package/src/dnd/index.ts +133 -0
  25. package/src/dnd/manager.ts +639 -0
  26. package/src/dnd/strings.ts +1279 -0
  27. package/src/dnd/targets.ts +726 -0
  28. package/src/dnd/types.ts +212 -0
  29. package/src/dom.ts +703 -0
  30. package/src/drag-and-drop.tsx +669 -0
  31. package/src/drawer.ts +674 -0
  32. package/src/dropzone.tsx +208 -0
  33. package/src/file-trigger.tsx +103 -0
  34. package/src/focus.ts +1370 -0
  35. package/src/form.tsx +94 -0
  36. package/src/gridlist.tsx +1354 -0
  37. package/src/group.tsx +146 -0
  38. package/src/i18n.ts +823 -0
  39. package/src/index.ts +1672 -0
  40. package/src/interactions/description.ts +73 -0
  41. package/src/interactions/flags.ts +35 -0
  42. package/src/interactions/focus-events.ts +226 -0
  43. package/src/interactions/focusable.ts +86 -0
  44. package/src/interactions/hover.ts +213 -0
  45. package/src/interactions/interact-outside.ts +123 -0
  46. package/src/interactions/keyboard.ts +298 -0
  47. package/src/interactions/listeners.ts +78 -0
  48. package/src/interactions/long-press.ts +160 -0
  49. package/src/interactions/modality.ts +428 -0
  50. package/src/interactions/move.ts +257 -0
  51. package/src/interactions/open-link.ts +226 -0
  52. package/src/interactions/press.ts +915 -0
  53. package/src/interactions/prevent-focus.ts +102 -0
  54. package/src/interactions/scroll-wheel.ts +43 -0
  55. package/src/interactions/text-selection.ts +77 -0
  56. package/src/interactions.ts +81 -0
  57. package/src/label.ts +140 -0
  58. package/src/link.tsx +477 -0
  59. package/src/listbox.tsx +1247 -0
  60. package/src/live.ts +208 -0
  61. package/src/menu.tsx +2383 -0
  62. package/src/menubar.tsx +579 -0
  63. package/src/navigation-tree.tsx +357 -0
  64. package/src/navigation.ts +735 -0
  65. package/src/numberfield.tsx +942 -0
  66. package/src/otp.ts +430 -0
  67. package/src/overlay-arrow.tsx +157 -0
  68. package/src/overlays.ts +1549 -0
  69. package/src/platform.ts +75 -0
  70. package/src/presence.ts +164 -0
  71. package/src/preview-trigger.tsx +582 -0
  72. package/src/progress-bar-context.ts +15 -0
  73. package/src/questionnaire.tsx +1717 -0
  74. package/src/radio.tsx +641 -0
  75. package/src/register-dom.ts +12 -0
  76. package/src/scroller.ts +1165 -0
  77. package/src/select.tsx +1745 -0
  78. package/src/selection-indicator.tsx +74 -0
  79. package/src/selection.ts +1472 -0
  80. package/src/shared-element-transition.tsx +316 -0
  81. package/src/sheet.tsx +1461 -0
  82. package/src/slider.tsx +1137 -0
  83. package/src/splitter.ts +1152 -0
  84. package/src/static-collection.ts +211 -0
  85. package/src/switch.tsx +212 -0
  86. package/src/table.tsx +2218 -0
  87. package/src/tabs.tsx +1127 -0
  88. package/src/tag.tsx +637 -0
  89. package/src/textarea.tsx +186 -0
  90. package/src/textfield.tsx +483 -0
  91. package/src/toast-components.tsx +589 -0
  92. package/src/toast.ts +658 -0
  93. package/src/toggle-button-group.tsx +175 -0
  94. package/src/toggle-input.tsx +86 -0
  95. package/src/toggle.ts +384 -0
  96. package/src/togglegroup.ts +365 -0
  97. package/src/tokenfield.tsx +1673 -0
  98. package/src/toolbar.tsx +184 -0
  99. package/src/tooltip.tsx +674 -0
  100. package/src/tree.tsx +2075 -0
  101. package/src/utils.ts +787 -0
  102. package/src/validation.ts +504 -0
  103. package/src/virtualizer.tsx +837 -0
package/src/tag.tsx ADDED
@@ -0,0 +1,637 @@
1
+ /**
2
+ * A tag group: removable labels, keywords or filters.
3
+ *
4
+ * A grid, not a list, for the same reason a grid list is: a tag holds a remove
5
+ * button, and an `option` may not contain anything interactive. So each tag is
6
+ * a row with one cell, the arrows move between them HORIZONTALLY, and Delete
7
+ * or Backspace removes.
8
+ *
9
+ * Two things only a tag group needs:
10
+ *
11
+ * - **Removing the last tag focuses the group.** Otherwise focus falls to the
12
+ * body and a keyboard user is thrown back to the top of the page by an
13
+ * action they took deliberately.
14
+ * - **The group is a live region while it has focus, and silent otherwise.**
15
+ * A tag disappearing under your hands is worth announcing; a filter panel
16
+ * updating five groups on the other side of the page is not, and
17
+ * `aria-relevant="additions"` keeps the removals from being read twice —
18
+ * once by the button and once by the region.
19
+ */
20
+
21
+ import {
22
+ cells,
23
+ type Accessor,
24
+ type Child,
25
+ For,
26
+ createMemo,
27
+ createContext,
28
+ createEffect,
29
+ getContext,
30
+ getOwner,
31
+ type Incoming,
32
+ install,
33
+ provide,
34
+ untrack,
35
+ } from "@barqjs/core";
36
+ import { isServer } from "@barqjs/web";
37
+ import { ref as makeRef, mergeRefs, type RefTarget } from "@barqjs/primitives/refs";
38
+ import { button } from "./button.tsx";
39
+ import type { ItemAccessors, Key, ListStateOptions, Node, SelectionMode } from "./collections.ts";
40
+ import { listState, type ListState } from "./collections.ts";
41
+ import { focusRing } from "./focus.ts";
42
+ import { StringDictionary, stringFormatter, useLocale } from "./i18n.ts";
43
+ import { description } from "./interactions/description.ts";
44
+ import { focusWithin } from "./interactions/focus-events.ts";
45
+ import { hover } from "./interactions/hover.ts";
46
+ import { modality } from "./interactions/modality.ts";
47
+ import type { ElementRef } from "./interactions/press.ts";
48
+ import { field, type FieldOptions } from "./label.ts";
49
+ import { SelectionIndicatorProvider } from "./selection-indicator.tsx";
50
+ import { SharedElementTransition } from "./shared-element-transition.tsx";
51
+ import {
52
+ ListKeyboardDelegate,
53
+ selectableItem,
54
+ selectableList,
55
+ type KeyboardDelegate,
56
+ } from "./selection.ts";
57
+ import {
58
+ access,
59
+ type DOMProps,
60
+ filterDOMProps,
61
+ fromProps,
62
+ id,
63
+ type MaybeAccessor,
64
+ mergeProps,
65
+ type StyleProps,
66
+ styleProps,
67
+ } from "./utils.ts";
68
+
69
+ // ---------------------------------------------------------------------------
70
+ // The group
71
+ // ---------------------------------------------------------------------------
72
+
73
+ export interface TagGroupOptions extends FieldOptions {
74
+ ref: ElementRef;
75
+ keyboardDelegate?: KeyboardDelegate;
76
+ disallowEmptySelection?: MaybeAccessor<boolean | undefined>;
77
+ escapeKeyBehavior?: MaybeAccessor<"clearSelection" | "none" | undefined>;
78
+ onRemove?: (keys: Set<Key>) => void;
79
+ }
80
+
81
+ export interface TagGroupResult {
82
+ gridProps: DOMProps;
83
+ labelProps: DOMProps;
84
+ descriptionProps: DOMProps;
85
+ errorMessageProps: DOMProps;
86
+ baseId: Accessor<string>;
87
+ }
88
+
89
+ export function tagGroup(options: TagGroupOptions, state: ListState<unknown>): TagGroupResult {
90
+ const baseId = id();
91
+ const locale = useLocale();
92
+
93
+ const delegate =
94
+ options.keyboardDelegate ??
95
+ new ListKeyboardDelegate({
96
+ collection: state.collection,
97
+ ref: options.ref,
98
+ // Tags flow across, so the arrows that move between them are the
99
+ // horizontal ones.
100
+ orientation: "horizontal",
101
+ direction: () => locale().direction,
102
+ disabledKeys: state.disabledKeys,
103
+ disabledBehavior: () => state.selectionManager().disabledBehavior,
104
+ });
105
+
106
+ const { labelProps, fieldProps, descriptionProps, errorMessageProps } = field({
107
+ ...options,
108
+ labelElementType: "span",
109
+ });
110
+
111
+ const { listProps } = selectableList({
112
+ ...options,
113
+ ref: options.ref,
114
+ selectionManager: state.selectionManager,
115
+ collection: state.collection,
116
+ disabledKeys: state.disabledKeys,
117
+ keyboardDelegate: delegate,
118
+ shouldFocusWrap: true,
119
+ linkBehavior: "override",
120
+ });
121
+
122
+ const { focusWithinProps, isFocusWithin } = focusWithin({});
123
+
124
+ if (!isServer) {
125
+ // Removing the LAST tag leaves nowhere inside to stand.
126
+ let previous = state.collection().size;
127
+ createEffect(
128
+ () => [state.collection().size, access(options.ref) as HTMLElement | null] as const,
129
+ ([size, element]) => {
130
+ if (previous > 0 && size === 0 && untrack(isFocusWithin) && element !== null)
131
+ element.focus();
132
+ previous = size;
133
+ },
134
+ );
135
+ }
136
+
137
+ const isEmpty = (): boolean => state.collection().size === 0;
138
+
139
+ return {
140
+ baseId,
141
+ labelProps,
142
+ descriptionProps,
143
+ errorMessageProps,
144
+ gridProps: mergeProps(
145
+ filterDOMProps(options, { labelable: true }),
146
+ listProps,
147
+ fieldProps,
148
+ focusWithinProps,
149
+ {
150
+ // An empty group is a group: `role="grid"` with no rows is a grid a
151
+ // screen reader reports as broken.
152
+ role: () => (isEmpty() ? "group" : "grid"),
153
+ id: baseId,
154
+ "aria-atomic": false,
155
+ "aria-relevant": "additions",
156
+ // Only while the user is IN it. A filter panel rebuilding five groups
157
+ // elsewhere on the page is not something to read out.
158
+ "aria-live": () => (isFocusWithin() ? "polite" : "off"),
159
+ },
160
+ ),
161
+ };
162
+ }
163
+
164
+ /** The id a tag renders under, derived from the key so anything can name it. */
165
+ export function tagIdFor(baseId: string, key: Key): string {
166
+ return `${baseId}-tag-${String(key)}`;
167
+ }
168
+
169
+ // ---------------------------------------------------------------------------
170
+ // A tag
171
+ // ---------------------------------------------------------------------------
172
+
173
+ export interface TagOptions {
174
+ key: Key;
175
+ ref: ElementRef;
176
+ baseId: MaybeAccessor<string>;
177
+ isDisabled?: MaybeAccessor<boolean | undefined>;
178
+ onRemove?: (keys: Set<Key>) => void;
179
+ onAction?: (key: Key) => void;
180
+ /** See `selectableItem`. @default `onAction !== undefined` */
181
+ hasAction?: MaybeAccessor<boolean | undefined>;
182
+ }
183
+
184
+ export interface TagResult {
185
+ rowProps: DOMProps;
186
+ gridCellProps: DOMProps;
187
+ /** Options for {@link button}, not props for an element. */
188
+ removeButtonProps: DOMProps;
189
+ allowsRemoving: Accessor<boolean>;
190
+ isSelected: Accessor<boolean>;
191
+ isFocused: Accessor<boolean>;
192
+ isPressed: Accessor<boolean>;
193
+ isDisabled: Accessor<boolean>;
194
+ }
195
+
196
+ const strings = new StringDictionary<"removeButtonLabel" | "removeDescription">({
197
+ "ar-AE": {
198
+ removeButtonLabel: "إزالة",
199
+ removeDescription: "اضغط على مفتاح DELETE لإزالة علامة.",
200
+ },
201
+ "bg-BG": {
202
+ removeButtonLabel: "Премахване",
203
+ removeDescription: "Натиснете Delete, за да премахнете маркера.",
204
+ },
205
+ "cs-CZ": {
206
+ removeButtonLabel: "Odebrat",
207
+ removeDescription: "Stisknutím klávesy Delete odeberete značku.",
208
+ },
209
+ "da-DK": {
210
+ removeButtonLabel: "Fjern",
211
+ removeDescription: "Tryk på Slet for at fjerne tag.",
212
+ },
213
+ "de-DE": {
214
+ removeButtonLabel: "Entfernen",
215
+ removeDescription: "Auf „Löschen“ drücken, um das Tag zu entfernen.",
216
+ },
217
+ "el-GR": {
218
+ removeButtonLabel: "Κατάργηση",
219
+ removeDescription: "Πατήστε Διαγραφή για να καταργήσετε την ετικέτα.",
220
+ },
221
+ "en-US": {
222
+ removeButtonLabel: "Remove",
223
+ removeDescription: "Press Delete to remove tag.",
224
+ },
225
+ "es-ES": {
226
+ removeButtonLabel: "Quitar",
227
+ removeDescription: "Pulse Eliminar para quitar la etiqueta.",
228
+ },
229
+ "et-EE": {
230
+ removeButtonLabel: "Eemalda",
231
+ removeDescription: "Sildi eemaldamiseks vajutage kustutusklahvi Delete.",
232
+ },
233
+ "fi-FI": {
234
+ removeButtonLabel: "Poista",
235
+ removeDescription: "Poista tunniste painamalla Poista-painiketta.",
236
+ },
237
+ "fr-FR": {
238
+ removeButtonLabel: "Supprimer",
239
+ removeDescription: "Appuyez sur Supprimer pour supprimer l’étiquette.",
240
+ },
241
+ "he-IL": {
242
+ removeButtonLabel: "הסר",
243
+ removeDescription: "לחץ על מחק כדי להסיר תג.",
244
+ },
245
+ "hr-HR": {
246
+ removeButtonLabel: "Ukloni",
247
+ removeDescription: "Pritisnite Delete za uklanjanje oznake.",
248
+ },
249
+ "hu-HU": {
250
+ removeButtonLabel: "Eltávolítás",
251
+ removeDescription: "Nyomja meg a Delete billentyűt a címke eltávolításához.",
252
+ },
253
+ "it-IT": {
254
+ removeButtonLabel: "Rimuovi",
255
+ removeDescription: "Premi Elimina per rimuovere il tag.",
256
+ },
257
+ "ja-JP": {
258
+ removeButtonLabel: "削除",
259
+ removeDescription: "タグを削除するには、Delete キーを押します。",
260
+ },
261
+ "ko-KR": {
262
+ removeButtonLabel: "제거",
263
+ removeDescription: "태그를 제거하려면 Delete 키를 누르십시오.",
264
+ },
265
+ "lt-LT": {
266
+ removeButtonLabel: "Pašalinti",
267
+ removeDescription: "Norėdami pašalinti žymą, paspauskite „Delete“ klavišą.",
268
+ },
269
+ "lv-LV": {
270
+ removeButtonLabel: "Noņemt",
271
+ removeDescription: "Nospiediet Delete [Dzēst], lai noņemtu tagu.",
272
+ },
273
+ "nb-NO": {
274
+ removeButtonLabel: "Fjern",
275
+ removeDescription: "Trykk på Slett for å fjerne taggen.",
276
+ },
277
+ "nl-NL": {
278
+ removeButtonLabel: "Verwijderen",
279
+ removeDescription: "Druk op Verwijderen om de tag te verwijderen.",
280
+ },
281
+ "pl-PL": {
282
+ removeButtonLabel: "Usuń",
283
+ removeDescription: "Naciśnij Usuń, aby usunąć znacznik.",
284
+ },
285
+ "pt-BR": {
286
+ removeButtonLabel: "Remover",
287
+ removeDescription: "Pressione Delete para remover a tag.",
288
+ },
289
+ "pt-PT": {
290
+ removeButtonLabel: "Eliminar",
291
+ removeDescription: "Prima Delete para eliminar a tag.",
292
+ },
293
+ "ro-RO": {
294
+ removeButtonLabel: "Îndepărtaţi",
295
+ removeDescription: "Apăsați pe Delete (Ștergere) pentru a elimina eticheta.",
296
+ },
297
+ "ru-RU": {
298
+ removeButtonLabel: "Удалить",
299
+ removeDescription: "Нажмите DELETE, чтобы удалить тег.",
300
+ },
301
+ "sk-SK": {
302
+ removeButtonLabel: "Odstrániť",
303
+ removeDescription: "Ak chcete odstrániť značku, stlačte kláves Delete.",
304
+ },
305
+ "sl-SI": {
306
+ removeButtonLabel: "Odstrani",
307
+ removeDescription: "Pritisnite Delete, da odstranite oznako.",
308
+ },
309
+ "sr-SP": {
310
+ removeButtonLabel: "Ukloni",
311
+ removeDescription: "Pritisnite Obriši da biste uklonili oznaku.",
312
+ },
313
+ "sv-SE": {
314
+ removeButtonLabel: "Ta bort",
315
+ removeDescription: "Tryck på Radera för att ta bort taggen.",
316
+ },
317
+ "tr-TR": {
318
+ removeButtonLabel: "Kaldır",
319
+ removeDescription: "Etiketi kaldırmak için Sil tuşuna basın.",
320
+ },
321
+ "uk-UA": {
322
+ removeButtonLabel: "Вилучити",
323
+ removeDescription: "Натисніть Delete, щоб вилучити тег.",
324
+ },
325
+ "zh-CN": {
326
+ removeButtonLabel: "删除",
327
+ removeDescription: "按下“删除”以删除标记。",
328
+ },
329
+ "zh-TW": {
330
+ removeButtonLabel: "移除",
331
+ removeDescription: "按 Delete 鍵以移除標記。",
332
+ },
333
+ });
334
+
335
+ export function tag(options: TagOptions, state: ListState<unknown>): TagResult {
336
+ const buttonId = id();
337
+ const message = stringFormatter(strings);
338
+ const how = modality();
339
+ const rowId = (): string => tagIdFor(access(options.baseId), options.key);
340
+ const node = (): Node<unknown> | null => state.collection().getItem(options.key);
341
+
342
+ const item = selectableItem({
343
+ key: options.key,
344
+ ref: options.ref,
345
+ id: rowId,
346
+ selectionManager: state.selectionManager,
347
+ isDisabled: options.isDisabled,
348
+ linkBehavior: "override",
349
+ hasAction: () => access(options.hasAction) ?? options.onAction !== undefined,
350
+ onAction: () => options.onAction?.(options.key),
351
+ });
352
+
353
+ const allowsRemoving = (): boolean => options.onRemove !== undefined;
354
+
355
+ /**
356
+ * Delete on a tag that is one of SEVERAL selected removes them all: the
357
+ * selection is what the user pointed at. The button is on one tag, and
358
+ * removes that one.
359
+ */
360
+ const removeFromKeyboard = (): void => {
361
+ if (item.isDisabled()) return;
362
+ const manager = state.selectionManager();
363
+ if (manager.isSelected(options.key)) {
364
+ options.onRemove?.(new Set(manager.selectedKeys));
365
+ return;
366
+ }
367
+ options.onRemove?.(new Set([options.key]));
368
+ };
369
+
370
+ const onKeyDown = (event: KeyboardEvent): void => {
371
+ if (!allowsRemoving() || item.isDisabled()) return;
372
+ if (event.key !== "Delete" && event.key !== "Backspace") return;
373
+ event.preventDefault();
374
+ removeFromKeyboard();
375
+ };
376
+
377
+ // Delete is the only way to remove a tag without a pointer, and nothing on
378
+ // screen says so; a pointer user has the button and needs no hint.
379
+ const hint = description(() =>
380
+ allowsRemoving() && (how() === "keyboard" || how() === "virtual")
381
+ ? message().format("removeDescription")
382
+ : undefined,
383
+ );
384
+
385
+ return {
386
+ allowsRemoving,
387
+ isSelected: item.isSelected,
388
+ isFocused: item.isFocused,
389
+ isPressed: item.isPressed,
390
+ isDisabled: item.isDisabled,
391
+ gridCellProps: { role: "gridcell" },
392
+ rowProps: mergeProps(item.itemProps, {
393
+ role: "row",
394
+ id: rowId,
395
+ onKeyDown,
396
+ "aria-label": () => node()?.["aria-label"] ?? node()?.textValue ?? undefined,
397
+ "aria-selected": () =>
398
+ state.selectionManager().canSelectItem(options.key) ? item.isSelected() : undefined,
399
+ "aria-disabled": () => item.isDisabled() || undefined,
400
+ "aria-describedby": hint["aria-describedby"],
401
+ }),
402
+ removeButtonProps: {
403
+ id: buttonId,
404
+ // Named by itself AND by the tag, so it is announced as "Remove,
405
+ // Barcelona" rather than as one of a row of identical Remove buttons.
406
+ "aria-label": () => message().format("removeButtonLabel"),
407
+ "aria-labelledby": () => `${buttonId()} ${rowId()}`,
408
+ isDisabled: item.isDisabled,
409
+ excludeFromTabOrder: true,
410
+ onPress: () => {
411
+ if (!item.isDisabled()) options.onRemove?.(new Set([options.key]));
412
+ },
413
+ },
414
+ };
415
+ }
416
+
417
+ // ---------------------------------------------------------------------------
418
+ // Components
419
+ // ---------------------------------------------------------------------------
420
+
421
+ interface TagGroupContextValue {
422
+ state: ListState<unknown>;
423
+ baseId: Accessor<string>;
424
+ onRemove: Accessor<((keys: Set<Key>) => void) | undefined>;
425
+ onAction?: Accessor<((key: Key) => void) | undefined>;
426
+ }
427
+
428
+ const TagGroupContext = createContext<TagGroupContextValue | null>(null);
429
+ const TagNodeContext = createContext<Node<unknown> | null>(null);
430
+
431
+ export function useTagGroup(): TagGroupContextValue {
432
+ const value = getContext(TagGroupContext);
433
+ if (value === null || value === undefined) {
434
+ throw new Error("A Tag must be rendered inside a TagGroup.");
435
+ }
436
+ return value;
437
+ }
438
+
439
+ /** The collection node the tag being built is for. */
440
+ export function useTagNode(): Node<unknown> {
441
+ const node = getContext(TagNodeContext);
442
+ if (node === null || node === undefined) {
443
+ throw new Error("A Tag must be rendered inside a TagGroup's item callback.");
444
+ }
445
+ return node;
446
+ }
447
+
448
+ function TagGroupProvider(props: { value: TagGroupContextValue; children?: Child }) {
449
+ return provide(
450
+ TagGroupContext,
451
+ () => props.value,
452
+ () => props.children as unknown,
453
+ );
454
+ }
455
+
456
+ export interface TagGroupComponentProps<T> extends StyleProps, ItemAccessors<T> {
457
+ /** The tags, in order. */
458
+ items: Iterable<T>;
459
+ /** How one tag renders. Return a `<Tag>`. */
460
+ children: (item: T) => Child;
461
+ label?: Child;
462
+ description?: Child;
463
+ errorMessage?: Child;
464
+ /** @default "none" */
465
+ selectionMode?: SelectionMode;
466
+ selectedKeys?: "all" | Iterable<Key>;
467
+ defaultSelectedKeys?: "all" | Iterable<Key>;
468
+ disabledKeys?: Iterable<Key>;
469
+ "aria-label"?: string;
470
+ "aria-labelledby"?: string;
471
+ ref?: RefTarget<HTMLDivElement>;
472
+ onSelectionChange?: (keys: "all" | Set<Key>) => void;
473
+ /** Without it the tags have no remove button and cannot be deleted. */
474
+ onRemove?: (keys: Set<Key>) => void;
475
+ /** A tag was activated: pressed, or Enter on it. */
476
+ onAction?: (key: Key) => void;
477
+ }
478
+
479
+ /**
480
+ * ```tsx
481
+ * <TagGroup label="Filters" items={filters()} onRemove={(keys) => drop(keys)}>
482
+ * {(filter) => <Tag>{filter.name}</Tag>}
483
+ * </TagGroup>
484
+ * ```
485
+ */
486
+ export function TagGroup<T>(props: TagGroupComponentProps<T>) {
487
+ const domRef = makeRef<HTMLDivElement>();
488
+ const options = fromProps(cells(props) as unknown as Incoming<Record<string, unknown>>);
489
+
490
+ const state = listState<T>({
491
+ ...(options as ListStateOptions<T>),
492
+ onSelectionChange: (keys) => props.onSelectionChange?.(keys),
493
+ });
494
+
495
+ const { gridProps, labelProps, descriptionProps, errorMessageProps, baseId } = tagGroup(
496
+ {
497
+ ...(options as unknown as TagGroupOptions),
498
+ ref: domRef,
499
+ onRemove: props.onRemove === undefined ? undefined : (keys) => props.onRemove?.(keys),
500
+ },
501
+ state,
502
+ );
503
+
504
+ const value: TagGroupContextValue = {
505
+ state: state,
506
+ baseId,
507
+ onRemove: () => props.onRemove,
508
+ onAction: () => props.onAction,
509
+ };
510
+
511
+ const { focusProps, isFocused, isFocusVisible } = focusRing();
512
+
513
+ const elementProps = mergeProps(
514
+ gridProps,
515
+ focusProps,
516
+ filterDOMProps(fromProps(cells(props)), { global: true }),
517
+ styleProps(cells(props)),
518
+ {
519
+ "data-empty": () => state.collection().size === 0,
520
+ "data-focused": isFocused,
521
+ "data-focus-visible": isFocusVisible,
522
+ "data-testid": () => props["data-testid"],
523
+ },
524
+ );
525
+
526
+ const render = props.children;
527
+
528
+ return (
529
+ <TagGroupProvider value={value}>
530
+ <span {...labelProps}>{props.label}</span>
531
+ <div {...elementProps} ref={mergeRefs(domRef.set, props.ref)}>
532
+ <SharedElementTransition>
533
+ <For each={() => [...state.collection()]}>
534
+ {(node: Node<T>) => {
535
+ const rowOwner = getOwner();
536
+ if (rowOwner !== null) install(rowOwner, TagNodeContext, () => node as Node<unknown>);
537
+ return render(node.value as T);
538
+ }}
539
+ </For>
540
+ </SharedElementTransition>
541
+ </div>
542
+ <span {...descriptionProps}>{props.description}</span>
543
+ <span {...errorMessageProps}>{props.errorMessage}</span>
544
+ </TagGroupProvider>
545
+ );
546
+ }
547
+
548
+ export interface TagComponentProps extends StyleProps {
549
+ children?: Child;
550
+ "aria-label"?: string;
551
+ ref?: RefTarget<HTMLDivElement>;
552
+ }
553
+
554
+ /**
555
+ * One tag, with a remove button when the group takes removals.
556
+ *
557
+ * The button is out of the Tab order: the tag itself is the stop, and Delete
558
+ * on it does the same thing. A second stop per tag would double the length of
559
+ * every filter bar.
560
+ */
561
+ export function Tag(props: TagComponentProps) {
562
+ const domRef = makeRef<HTMLDivElement>();
563
+ const buttonRef = makeRef<HTMLButtonElement>();
564
+ const group = useTagGroup();
565
+ const node = useTagNode();
566
+
567
+ const {
568
+ rowProps,
569
+ gridCellProps,
570
+ removeButtonProps,
571
+ allowsRemoving,
572
+ isSelected,
573
+ isFocused,
574
+ isPressed,
575
+ isDisabled,
576
+ } = tag(
577
+ {
578
+ key: node.key,
579
+ ref: domRef,
580
+ baseId: group.baseId,
581
+ isDisabled: () => node.props?.isDisabled === true,
582
+ onRemove: group.onRemove() === undefined ? undefined : (keys) => group.onRemove()?.(keys),
583
+ hasAction: () => group.onAction?.() !== undefined,
584
+ onAction: (key) => group.onAction?.()?.(key),
585
+ },
586
+ group.state,
587
+ );
588
+
589
+ const { buttonProps } = button(removeButtonProps, buttonRef);
590
+ const { hoverProps, isHovered } = hover({ isDisabled });
591
+ const { focusProps, isFocusVisible } = focusRing();
592
+
593
+ const elementProps = mergeProps(
594
+ rowProps,
595
+ hoverProps,
596
+ focusProps,
597
+ filterDOMProps(fromProps(cells(props)), { global: true }),
598
+ styleProps(cells(props)),
599
+ {
600
+ "aria-label": () => props["aria-label"],
601
+ "data-selected": isSelected,
602
+ "data-focused": isFocused,
603
+ "data-focus-visible": isFocusVisible,
604
+ "data-pressed": isPressed,
605
+ "data-hovered": isHovered,
606
+ "data-disabled": isDisabled,
607
+ "data-removable": allowsRemoving,
608
+ "data-allows-removing": allowsRemoving,
609
+ "data-selection-mode": () => {
610
+ const mode = group.state.selectionManager().selectionMode;
611
+ return mode === "none" ? undefined : mode;
612
+ },
613
+ "data-testid": () => props["data-testid"],
614
+ },
615
+ );
616
+
617
+ const removeProps = createMemo(() =>
618
+ mergeProps(buttonProps, { id: removeButtonProps.id, type: "button" }),
619
+ );
620
+
621
+ return (
622
+ <div {...elementProps} ref={mergeRefs(domRef.set, props.ref)}>
623
+ <div {...gridCellProps}>
624
+ <SelectionIndicatorProvider isSelected={isSelected()}>
625
+ {props.children}
626
+ </SelectionIndicatorProvider>
627
+ {() =>
628
+ allowsRemoving() ? (
629
+ <button {...removeProps()} ref={buttonRef.set}>
630
+ <span aria-hidden="true">×</span>
631
+ </button>
632
+ ) : null
633
+ }
634
+ </div>
635
+ </div>
636
+ );
637
+ }