@gunkin/uiify 0.0.14-alpha → 0.0.16-alpha
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 +46 -1
- package/agents/components.md +80 -0
- package/agents/index.md +179 -0
- package/agents/reference/components/accordion.md +35 -0
- package/agents/reference/components/alert-modal.md +63 -0
- package/agents/reference/components/breadcrumb.md +72 -0
- package/agents/reference/components/button.md +40 -0
- package/agents/reference/components/candle-chart.md +107 -0
- package/agents/reference/components/carousel.md +274 -0
- package/agents/reference/components/checkbox.md +32 -0
- package/agents/reference/components/collapsible.md +26 -0
- package/agents/reference/components/color-picker.md +33 -0
- package/agents/reference/components/combobox.md +193 -0
- package/agents/reference/components/context-menu.md +129 -0
- package/agents/reference/components/drawer.md +215 -0
- package/agents/reference/components/dropdown-menu.md +178 -0
- package/agents/reference/components/field.md +76 -0
- package/agents/reference/components/file-upload.md +131 -0
- package/agents/reference/components/form.md +28 -0
- package/agents/reference/components/header.md +44 -0
- package/agents/reference/components/hover-card.md +54 -0
- package/agents/reference/components/input.md +29 -0
- package/agents/reference/components/line-chart.md +104 -0
- package/agents/reference/components/modal.md +106 -0
- package/agents/reference/components/number-field.md +60 -0
- package/agents/reference/components/otp-input.md +68 -0
- package/agents/reference/components/pagination.md +112 -0
- package/agents/reference/components/popup.md +111 -0
- package/agents/reference/components/radio-group.md +37 -0
- package/agents/reference/components/rating.md +43 -0
- package/agents/reference/components/segmented-control.md +51 -0
- package/agents/reference/components/select.md +60 -0
- package/agents/reference/components/skeleton.md +29 -0
- package/agents/reference/components/slider.md +71 -0
- package/agents/reference/components/spinner.md +34 -0
- package/agents/reference/components/switch.md +27 -0
- package/agents/reference/components/table-of-contents.md +185 -0
- package/agents/reference/components/table.md +189 -0
- package/agents/reference/components/tabs.md +42 -0
- package/agents/reference/components/tags-input.md +123 -0
- package/agents/reference/components/textarea.md +31 -0
- package/agents/reference/components/toast.md +151 -0
- package/agents/reference/components/toggle-group.md +50 -0
- package/agents/reference/components/toggle.md +26 -0
- package/agents/reference/components/toolbar.md +69 -0
- package/agents/reference/components/tooltip.md +76 -0
- package/agents/reference/components/virtual-scroll.md +97 -0
- package/agents/reference/elements/choice.md +55 -0
- package/agents/reference/elements/details.md +45 -0
- package/agents/reference/elements/dialog.md +43 -0
- package/agents/reference/elements/invoker.md +28 -0
- package/agents/reference/elements/popover.md +53 -0
- package/dist/components/alert-modal/AlertModalParts.js +1 -1
- package/dist/components/alert-modal/AlertModalParts.js.map +1 -1
- package/dist/components/button/Button.d.ts.map +1 -1
- package/dist/components/button/Button.js +5 -3
- package/dist/components/button/Button.js.map +1 -1
- package/dist/components/button/index.d.ts +1 -1
- package/dist/components/button/index.d.ts.map +1 -1
- package/dist/components/button/index.js.map +1 -1
- package/dist/components/button/types.d.ts +5 -4
- package/dist/components/button/types.d.ts.map +1 -1
- package/dist/components/carousel/CarouselMarkup.d.ts.map +1 -1
- package/dist/components/carousel/CarouselMarkup.js +8 -0
- package/dist/components/carousel/CarouselMarkup.js.map +1 -1
- package/dist/components/dropdown-menu/DropdownMenu.d.ts.map +1 -1
- package/dist/components/dropdown-menu/DropdownMenu.js +0 -2
- package/dist/components/dropdown-menu/DropdownMenu.js.map +1 -1
- package/dist/components/dropdown-menu/types.d.ts +0 -1
- package/dist/components/dropdown-menu/types.d.ts.map +1 -1
- package/dist/components/index.d.ts +1 -0
- package/dist/components/index.d.ts.map +1 -1
- package/dist/components/index.js +1 -0
- package/dist/components/index.js.map +1 -1
- package/dist/components/internal/choice-family/ChoiceGroup.d.ts.map +1 -1
- package/dist/components/internal/choice-family/ChoiceGroup.js +2 -3
- package/dist/components/internal/choice-family/ChoiceGroup.js.map +1 -1
- package/dist/components/internal/choice-family/types.d.ts +2 -2
- package/dist/components/internal/choice-family/types.d.ts.map +1 -1
- package/dist/components/pagination/Pagination.d.ts.map +1 -1
- package/dist/components/pagination/Pagination.js +11 -0
- package/dist/components/pagination/Pagination.js.map +1 -1
- package/dist/components/pagination/PaginationShell.d.ts.map +1 -1
- package/dist/components/pagination/PaginationShell.js +26 -1
- package/dist/components/pagination/PaginationShell.js.map +1 -1
- package/dist/components/segmented-control/SegmentedControl.d.ts.map +1 -1
- package/dist/components/segmented-control/SegmentedControl.js +1 -0
- package/dist/components/segmented-control/SegmentedControl.js.map +1 -1
- package/dist/components/segmented-control/client/SegmentedControlClient.d.ts.map +1 -1
- package/dist/components/segmented-control/client/SegmentedControlClient.js +1 -0
- package/dist/components/segmented-control/client/SegmentedControlClient.js.map +1 -1
- package/dist/components/table-of-contents/TableOfContents.d.ts +22 -0
- package/dist/components/table-of-contents/TableOfContents.d.ts.map +1 -0
- package/dist/components/table-of-contents/TableOfContents.js +142 -0
- package/dist/components/table-of-contents/TableOfContents.js.map +1 -0
- package/dist/components/table-of-contents/client/TableOfContentsClient.d.ts +18 -0
- package/dist/components/table-of-contents/client/TableOfContentsClient.d.ts.map +1 -0
- package/dist/components/table-of-contents/client/TableOfContentsClient.js +140 -0
- package/dist/components/table-of-contents/client/TableOfContentsClient.js.map +1 -0
- package/dist/components/table-of-contents/client/TableOfContentsClientParts.d.ts +7 -0
- package/dist/components/table-of-contents/client/TableOfContentsClientParts.d.ts.map +1 -0
- package/dist/components/table-of-contents/client/TableOfContentsClientParts.js +48 -0
- package/dist/components/table-of-contents/client/TableOfContentsClientParts.js.map +1 -0
- package/dist/components/table-of-contents/client/index.d.ts +5 -0
- package/dist/components/table-of-contents/client/index.d.ts.map +1 -0
- package/dist/components/table-of-contents/client/index.js +23 -0
- package/dist/components/table-of-contents/client/index.js.map +1 -0
- package/dist/components/table-of-contents/client/table-of-contents-context.d.ts +3 -0
- package/dist/components/table-of-contents/client/table-of-contents-context.d.ts.map +1 -0
- package/dist/components/table-of-contents/client/table-of-contents-context.js +7 -0
- package/dist/components/table-of-contents/client/table-of-contents-context.js.map +1 -0
- package/dist/components/table-of-contents/client/table-of-contents-interactions.d.ts +3 -0
- package/dist/components/table-of-contents/client/table-of-contents-interactions.d.ts.map +1 -0
- package/dist/components/table-of-contents/client/table-of-contents-interactions.js +144 -0
- package/dist/components/table-of-contents/client/table-of-contents-interactions.js.map +1 -0
- package/dist/components/table-of-contents/client/table-of-contents-pointer.d.ts +3 -0
- package/dist/components/table-of-contents/client/table-of-contents-pointer.d.ts.map +1 -0
- package/dist/components/table-of-contents/client/table-of-contents-pointer.js +94 -0
- package/dist/components/table-of-contents/client/table-of-contents-pointer.js.map +1 -0
- package/dist/components/table-of-contents/client.d.ts +1 -0
- package/dist/components/table-of-contents/client.js +1 -0
- package/dist/components/table-of-contents/index.d.ts +3 -0
- package/dist/components/table-of-contents/index.d.ts.map +1 -0
- package/dist/components/table-of-contents/index.js +21 -0
- package/dist/components/table-of-contents/index.js.map +1 -0
- package/dist/components/table-of-contents/scrollspy-selection.d.ts +4 -0
- package/dist/components/table-of-contents/scrollspy-selection.d.ts.map +1 -0
- package/dist/components/table-of-contents/scrollspy-selection.js +31 -0
- package/dist/components/table-of-contents/scrollspy-selection.js.map +1 -0
- package/dist/components/table-of-contents/scrollspy.d.ts +4 -0
- package/dist/components/table-of-contents/scrollspy.d.ts.map +1 -0
- package/dist/components/table-of-contents/scrollspy.js +178 -0
- package/dist/components/table-of-contents/scrollspy.js.map +1 -0
- package/dist/components/table-of-contents/types.d.ts +123 -0
- package/dist/components/table-of-contents/types.d.ts.map +1 -0
- package/dist/components/table-of-contents/types.js +1 -0
- package/dist/components/table-of-contents/types.js.map +1 -0
- package/dist/components/table-of-contents.d.ts +1 -0
- package/dist/components/table-of-contents.js +1 -0
- package/dist/components/toggle/Toggle.d.ts.map +1 -1
- package/dist/components/toggle/Toggle.js +12 -1
- package/dist/components/toggle/Toggle.js.map +1 -1
- package/dist/components/toggle-group/ToggleGroup.d.ts +1 -1
- package/dist/components/toggle-group/ToggleGroup.d.ts.map +1 -1
- package/dist/components/toggle-group/ToggleGroup.js +6 -1
- package/dist/components/toggle-group/ToggleGroup.js.map +1 -1
- package/dist/components/toggle-group/client/ToggleGroupClient.d.ts +1 -1
- package/dist/components/toggle-group/client/ToggleGroupClient.d.ts.map +1 -1
- package/dist/components/toggle-group/client/ToggleGroupClient.js +19 -6
- package/dist/components/toggle-group/client/ToggleGroupClient.js.map +1 -1
- package/dist/components/toggle-group/types.d.ts +3 -3
- package/dist/components/toggle-group/types.d.ts.map +1 -1
- package/dist/components/toolbar/ToolbarShell.d.ts.map +1 -1
- package/dist/components/toolbar/ToolbarShell.js +5 -2
- package/dist/components/toolbar/ToolbarShell.js.map +1 -1
- package/dist/components/toolbar/types.d.ts +2 -1
- package/dist/components/toolbar/types.d.ts.map +1 -1
- package/dist/core/render-native-invoker.d.ts +1 -1
- package/dist/core/render-native-invoker.d.ts.map +1 -1
- package/dist/core/render-native-invoker.js.map +1 -1
- package/dist/styles/index.css +1 -1
- package/package.json +4 -2
- package/skills/uiify/SKILL.md +167 -0
- package/skills/uiify/scripts/lint.mjs +56 -0
- package/skills/uiify/scripts/static.mjs +95 -0
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# table
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/table`
|
|
5
|
+
- Tier 0 (RSC — zero client JavaScript); state source none; native element `table`
|
|
6
|
+
- Without JavaScript: full
|
|
7
|
+
- Types file: `dist/components/table.d.ts`
|
|
8
|
+
- Note: Native semantic Table parts; selection, sorting and expansion use the explicit /client entry.
|
|
9
|
+
|
|
10
|
+
## Exports
|
|
11
|
+
|
|
12
|
+
- Runtime: `Table`, `TableFooter`, `TableRowHeader`, `TableBody`, `TableCaption`, `TableCell`, `TableColumnHeader`, `TableHeader`, `TableRoot`, `TableRow`
|
|
13
|
+
- Types: `TableFooterProps`, `TableRowHeaderProps`, `TableStickySectionOwnProps`, `TableStickyCellOwnProps`, `TableBodyProps`, `TableCaptionProps`, `TableCellProps`, `TableColumnHeaderOwnProps`, `TableColumnHeaderProps`, `TableContextValue`, `TableInteractiveRootOwnProps`, `TableHeaderProps`, `TableRowSelectOwnProps`, `TableRowOwnProps`, `TableRowProps`, `TableStore`, `TableStoreOptions`, `TableRootProps`, `SelectionMode`, `SortDescriptor`, `SortDirection`
|
|
14
|
+
|
|
15
|
+
## Values
|
|
16
|
+
|
|
17
|
+
- `SortDirection`: `"ascending" | "descending"`
|
|
18
|
+
- `SelectionMode`: `"none" | "single" | "multiple"`
|
|
19
|
+
- `SelectionBehavior`: `"toggle" | "replace"`
|
|
20
|
+
|
|
21
|
+
## Props and shapes
|
|
22
|
+
|
|
23
|
+
### SortDescriptor
|
|
24
|
+
|
|
25
|
+
| Member | Type | Required | Description |
|
|
26
|
+
| --- | --- | --- | --- |
|
|
27
|
+
| `column` | `string` | yes | |
|
|
28
|
+
| `direction` | `SortDirection` | yes | |
|
|
29
|
+
|
|
30
|
+
### TableStoreOptions
|
|
31
|
+
|
|
32
|
+
| Member | Type | Required | Description |
|
|
33
|
+
| --- | --- | --- | --- |
|
|
34
|
+
| `defaultSelectedKeys` | `Iterable<string>` | no | |
|
|
35
|
+
| `defaultSortDescriptor` | `SortDescriptor \| null` | no | |
|
|
36
|
+
| `onSelectionChange` | `((selectedKeys: Set<string>) => void) \| undefined` | no | |
|
|
37
|
+
| `onSortChange` | `((descriptor: SortDescriptor \| null) => void) \| undefined` | no | |
|
|
38
|
+
| `selectedKeys` | `Iterable<string>` | no | |
|
|
39
|
+
| `selectionBehavior` | `SelectionBehavior` | no | |
|
|
40
|
+
| `selectionMode` | `SelectionMode` | no | |
|
|
41
|
+
| `sortDescriptor` | `SortDescriptor \| null` | no | |
|
|
42
|
+
|
|
43
|
+
### TableStore
|
|
44
|
+
|
|
45
|
+
| Member | Type | Required | Description |
|
|
46
|
+
| --- | --- | --- | --- |
|
|
47
|
+
| `getRowIds` | `() => string[]` | yes | |
|
|
48
|
+
| `getSelectedKeys` | `() => Set<string>` | yes | |
|
|
49
|
+
| `getSelectionState` | `() => "none" \| "some" \| "all"` | yes | |
|
|
50
|
+
| `getServerSelectedSnapshot` | `() => Set<string>` | yes | |
|
|
51
|
+
| `getServerSortSnapshot` | `() => SortDescriptor \| null` | yes | |
|
|
52
|
+
| `getSortSnapshot` | `() => SortDescriptor \| null` | yes | |
|
|
53
|
+
| `isRowSelected` | `(id: string) => boolean` | yes | |
|
|
54
|
+
| `registerRow` | `(id: string) => () => void` | yes | |
|
|
55
|
+
| `setRowDisabled` | `(id: string, disabled: boolean) => void` | yes | |
|
|
56
|
+
| `setRowIds` | `(ids: readonly string[]) => void` | yes | |
|
|
57
|
+
| `setSelectedKeys` | `(keys: Iterable<string>) => void` | yes | |
|
|
58
|
+
| `setSortDescriptor` | `(descriptor: SortDescriptor \| null) => void` | yes | |
|
|
59
|
+
| `subscribe` | `(listener: () => void) => () => void` | yes | |
|
|
60
|
+
| `subscribeRow` | `(id: string, listener: () => void) => () => void` | yes | |
|
|
61
|
+
| `subscribeSelection` | `(listener: () => void) => () => void` | yes | |
|
|
62
|
+
| `subscribeSort` | `(listener: () => void) => () => void` | yes | |
|
|
63
|
+
| `syncSelectedKeys` | `(keys: Iterable<string>) => void` | yes | |
|
|
64
|
+
| `syncSortDescriptor` | `(descriptor: SortDescriptor \| null) => void` | yes | |
|
|
65
|
+
| `toggleRow` | `(id: string, toggleOptions?: { readonly disabled?: boolean; readonly metaKey?: boolean; readonly shiftKey?: boolean; }) => void` | yes | |
|
|
66
|
+
| `toggleSelectAll` | `() => void` | yes | |
|
|
67
|
+
| `toggleSort` | `(column: string) => void` | yes | |
|
|
68
|
+
| `updateOptions` | `(nextOptions: TableStoreOptions) => void` | yes | |
|
|
69
|
+
|
|
70
|
+
### TableContextValue
|
|
71
|
+
|
|
72
|
+
| Member | Type | Required | Description |
|
|
73
|
+
| --- | --- | --- | --- |
|
|
74
|
+
| `inBody` | `boolean` | yes | |
|
|
75
|
+
| `interactive` | `boolean` | yes | |
|
|
76
|
+
| `instanceId` | `string` | yes | |
|
|
77
|
+
| `expandedKeys` | `Set<string>` | yes | |
|
|
78
|
+
| `toggleExpanded` | `(id: string) => void` | yes | |
|
|
79
|
+
| `store` | `TableStore` | yes | |
|
|
80
|
+
|
|
81
|
+
### TableRootOwnProps
|
|
82
|
+
|
|
83
|
+
| Member | Type | Required | Description |
|
|
84
|
+
| --- | --- | --- | --- |
|
|
85
|
+
| `"aria-label"` | `string` | no | |
|
|
86
|
+
| `"aria-labelledby"` | `string` | no | |
|
|
87
|
+
| `layout` | `"auto" \| "fixed"` | no | |
|
|
88
|
+
| `size` | `"sm" \| "md" \| "lg"` | no | |
|
|
89
|
+
| `variant` | `"solid" \| "outline" \| "ghost"` | no | |
|
|
90
|
+
|
|
91
|
+
### TableInteractiveRootOwnProps
|
|
92
|
+
|
|
93
|
+
| Member | Type | Required | Description |
|
|
94
|
+
| --- | --- | --- | --- |
|
|
95
|
+
| `defaultSelectedKeys` | `Iterable<string>` | no | |
|
|
96
|
+
| `onSelectionChange` | `(selectedKeys: Set<string>) => void` | no | |
|
|
97
|
+
| `onSortChange` | `(descriptor: SortDescriptor \| null) => void` | no | |
|
|
98
|
+
| `selectedKeys` | `Iterable<string>` | no | |
|
|
99
|
+
| `selectionBehavior` | `SelectionBehavior` | no | |
|
|
100
|
+
| `selectionMode` | `SelectionMode` | no | |
|
|
101
|
+
|
|
102
|
+
### TableRowOwnProps
|
|
103
|
+
|
|
104
|
+
Extends: `TableStickySectionOwnProps`
|
|
105
|
+
|
|
106
|
+
| Member | Type | Required | Description |
|
|
107
|
+
| --- | --- | --- | --- |
|
|
108
|
+
| `disabled` | `boolean` | no | |
|
|
109
|
+
| `id` | `string` | yes | |
|
|
110
|
+
| `selected` | `boolean` | no | |
|
|
111
|
+
|
|
112
|
+
### TableColumnHeaderOwnProps
|
|
113
|
+
|
|
114
|
+
Extends: `TableStickyCellOwnProps`
|
|
115
|
+
|
|
116
|
+
| Member | Type | Required | Description |
|
|
117
|
+
| --- | --- | --- | --- |
|
|
118
|
+
| `allowsSorting` | `boolean` | no | |
|
|
119
|
+
| `children` | `ReactNode` | no | |
|
|
120
|
+
| `id` | `string` | yes | |
|
|
121
|
+
| `onClick` | `React.MouseEventHandler<HTMLTableCellElement>` | no | |
|
|
122
|
+
| `sortDirection` | `SortDescriptor["direction"] \| null` | no | |
|
|
123
|
+
|
|
124
|
+
### TableRowSelectOwnProps
|
|
125
|
+
|
|
126
|
+
| Member | Type | Required | Description |
|
|
127
|
+
| --- | --- | --- | --- |
|
|
128
|
+
| `rowId` | `string` | yes | |
|
|
129
|
+
|
|
130
|
+
### TableClientRootOwnProps
|
|
131
|
+
|
|
132
|
+
Extends: `TableRootOwnProps`
|
|
133
|
+
|
|
134
|
+
| Member | Type | Required | Description |
|
|
135
|
+
| --- | --- | --- | --- |
|
|
136
|
+
| `defaultSelectedKeys` | `Iterable<string>` | no | |
|
|
137
|
+
| `defaultSortDescriptor` | `SortDescriptor \| null` | no | |
|
|
138
|
+
| `onSelectionChange` | `(selectedKeys: Set<string>) => void` | no | |
|
|
139
|
+
| `onSortChange` | `(descriptor: SortDescriptor \| null) => void` | no | |
|
|
140
|
+
| `selectedKeys` | `Iterable<string>` | no | |
|
|
141
|
+
| `selectionBehavior` | `SelectionBehavior` | no | |
|
|
142
|
+
| `selectionMode` | `SelectionMode` | no | |
|
|
143
|
+
| `sortDescriptor` | `SortDescriptor \| null` | no | |
|
|
144
|
+
| `expandedKeys` | `Iterable<string>` | no | |
|
|
145
|
+
| `defaultExpandedKeys` | `Iterable<string>` | no | |
|
|
146
|
+
| `onExpandedChange` | `(keys: Set<string>) => void` | no | |
|
|
147
|
+
|
|
148
|
+
### TableStickySectionOwnProps
|
|
149
|
+
|
|
150
|
+
| Member | Type | Required | Description |
|
|
151
|
+
| --- | --- | --- | --- |
|
|
152
|
+
| `sticky` | `boolean` | no | |
|
|
153
|
+
|
|
154
|
+
### TableStickyCellOwnProps
|
|
155
|
+
|
|
156
|
+
| Member | Type | Required | Description |
|
|
157
|
+
| --- | --- | --- | --- |
|
|
158
|
+
| `align` | `"start" \| "center" \| "end"` | no | |
|
|
159
|
+
| `sticky` | `"start" \| "end"` | no | |
|
|
160
|
+
| `children` | `ReactNode` | no | |
|
|
161
|
+
|
|
162
|
+
### TableExpandTriggerProps
|
|
163
|
+
|
|
164
|
+
Extends: `Omit<ComponentPropsWithRef<"button">, "aria-expanded" | "aria-controls">`
|
|
165
|
+
|
|
166
|
+
| Member | Type | Required | Description |
|
|
167
|
+
| --- | --- | --- | --- |
|
|
168
|
+
| `rowId` | `string` | yes | |
|
|
169
|
+
|
|
170
|
+
### TableExpandedRowProps
|
|
171
|
+
|
|
172
|
+
Extends: `Omit<ComponentPropsWithRef<"tr">, "hidden" | "id">`
|
|
173
|
+
|
|
174
|
+
| Member | Type | Required | Description |
|
|
175
|
+
| --- | --- | --- | --- |
|
|
176
|
+
| `rowId` | `string` | yes | |
|
|
177
|
+
|
|
178
|
+
## Other types
|
|
179
|
+
|
|
180
|
+
- `TableRootProps<TAs>`: `RenderableProps<TAs, TableRootOwnProps, Record<string, never>, HTMLTableElement>`
|
|
181
|
+
- `TableHeaderProps<TAs>`: `RenderableProps<TAs, TableStickySectionOwnProps, Record<string, never>, HTMLTableSectionElement>`
|
|
182
|
+
- `TableBodyProps<TAs>`: `RenderableProps<TAs, { readonly children?: ReactNode }, Record<string, never>, HTMLTableSectionElement>`
|
|
183
|
+
- `TableRowProps<TAs>`: `RenderableProps<TAs, TableRowOwnProps, { selected: boolean }, HTMLTableRowElement>`
|
|
184
|
+
- `TableColumnHeaderProps<TAs>`: `RenderableProps<TAs, TableColumnHeaderOwnProps, Record<string, never>, HTMLTableCellElement>`
|
|
185
|
+
- `TableCellProps<TAs>`: `RenderableProps<TAs, TableStickyCellOwnProps, Record<string, never>, HTMLTableCellElement>`
|
|
186
|
+
- `TableCaptionProps<TAs>`: `RenderableProps<TAs, { readonly children?: ReactNode }, Record<string, never>, HTMLTableCaptionElement>`
|
|
187
|
+
- `TableClientRootProps<TAs>`: `RenderableProps<TAs, TableClientRootOwnProps, Record<string, never>, HTMLTableElement>`
|
|
188
|
+
- `TableFooterProps<TAs>`: `RenderableProps<TAs, TableStickySectionOwnProps, Record<string, never>, HTMLTableSectionElement>`
|
|
189
|
+
- `TableRowHeaderProps<TAs>`: `RenderableProps<TAs, TableStickyCellOwnProps, Record<string, never>, HTMLTableCellElement>`
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# tabs
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/tabs`
|
|
5
|
+
- Tier 0 (RSC — zero client JavaScript); state source S1; native element `input[type=radio]`
|
|
6
|
+
- Without JavaScript: full
|
|
7
|
+
- Types file: `dist/components/tabs.d.ts`
|
|
8
|
+
- Note: Data-driven native radio switcher; CSS-only panels. Built on @gunkin/uiify/elements/choice.
|
|
9
|
+
|
|
10
|
+
## Exports
|
|
11
|
+
|
|
12
|
+
- Runtime: `Tabs`
|
|
13
|
+
- Types: `TabsItem`, `TabsProps`
|
|
14
|
+
|
|
15
|
+
## Props and shapes
|
|
16
|
+
|
|
17
|
+
### TabsStore
|
|
18
|
+
|
|
19
|
+
| Member | Type | Required | Description |
|
|
20
|
+
| --- | --- | --- | --- |
|
|
21
|
+
| `getValue` | `() => string \| undefined` | yes | |
|
|
22
|
+
| `isSelected` | `(itemValue: string) => boolean` | yes | |
|
|
23
|
+
| `setValue` | `(next: string \| undefined) => void` | yes | |
|
|
24
|
+
| `subscribe` | `(listener: () => void) => () => void` | yes | |
|
|
25
|
+
| `subscribeItem` | `(itemValue: string, listener: () => void) => () => void` | yes | |
|
|
26
|
+
|
|
27
|
+
### TabsItem
|
|
28
|
+
|
|
29
|
+
Extends: `ChoicePanelItem`
|
|
30
|
+
|
|
31
|
+
No own members.
|
|
32
|
+
|
|
33
|
+
### TabsProps
|
|
34
|
+
|
|
35
|
+
| Member | Type | Required | Description |
|
|
36
|
+
| --- | --- | --- | --- |
|
|
37
|
+
| `id` | `string` | yes | |
|
|
38
|
+
| `items` | `readonly TabsItem[]` | yes | |
|
|
39
|
+
| `defaultValue` | `string` | no | |
|
|
40
|
+
| `orientation` | `ChoiceOrientation` | no | |
|
|
41
|
+
| `className` | `string` | no | |
|
|
42
|
+
| `append` | `ReactNode` | no | Optional control rendered at the end of the tab bar. |
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# tags-input
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/tags-input`
|
|
5
|
+
- Tier 2 (Client component — pre-hydration SSR); state source none; native element `input`
|
|
6
|
+
- Without JavaScript: pre-hydration-only
|
|
7
|
+
- Types file: `dist/components/tags-input.d.ts`
|
|
8
|
+
|
|
9
|
+
## Exports
|
|
10
|
+
|
|
11
|
+
- Runtime: `TagsInput`, `TagsInputInput`, `TagsInputList`, `TagsInputRoot`, `TagsInputTag`, `TagsInputTagRemove`, `splitTags`
|
|
12
|
+
- Types: `TagsInputInputOwnProps`, `TagsInputInputProps`, `TagsInputRootControlledOwnProps`, `TagsInputRootShellOwnProps`, `TagsInputRootShellProps`, `TagsInputRootProps`, `TagsInputTagOwnProps`, `TagsInputTagProps`, `TagsInputStore`
|
|
13
|
+
|
|
14
|
+
## Props and shapes
|
|
15
|
+
|
|
16
|
+
### TagsInputStoreOptions
|
|
17
|
+
|
|
18
|
+
| Member | Type | Required | Description |
|
|
19
|
+
| --- | --- | --- | --- |
|
|
20
|
+
| `allowDuplicates` | `boolean` | no | |
|
|
21
|
+
| `maxTags` | `number` | no | |
|
|
22
|
+
| `validate` | `(tag: string) => boolean` | no | |
|
|
23
|
+
|
|
24
|
+
### TagsInputStore
|
|
25
|
+
|
|
26
|
+
| Member | Type | Required | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| `addTag` | `(tag: string) => boolean` | yes | |
|
|
29
|
+
| `addTags` | `(nextTags: readonly string[]) => void` | yes | |
|
|
30
|
+
| `getTags` | `() => string[]` | yes | |
|
|
31
|
+
| `removeAt` | `(index: number) => void` | yes | |
|
|
32
|
+
| `removeLast` | `() => void` | yes | |
|
|
33
|
+
| `setTags` | `(next: readonly string[]) => void` | yes | |
|
|
34
|
+
| `subscribe` | `(listener: () => void) => () => void` | yes | |
|
|
35
|
+
| `updateOptions` | `(next: TagsInputStoreOptions) => void` | yes | |
|
|
36
|
+
|
|
37
|
+
### TagsInputContextValue
|
|
38
|
+
|
|
39
|
+
| Member | Type | Required | Description |
|
|
40
|
+
| --- | --- | --- | --- |
|
|
41
|
+
| `addOnPaste` | `boolean` | yes | |
|
|
42
|
+
| `addTag` | `(tag: string) => void` | yes | |
|
|
43
|
+
| `delimiters` | `readonly string[]` | yes | |
|
|
44
|
+
| `disabled` | `boolean` | yes | |
|
|
45
|
+
| `inputId` | `string` | yes | |
|
|
46
|
+
| `inputValue` | `string` | yes | |
|
|
47
|
+
| `listId` | `string` | yes | |
|
|
48
|
+
| `removeAt` | `(index: number) => void` | yes | |
|
|
49
|
+
| `setInputValue` | `(value: string) => void` | yes | |
|
|
50
|
+
| `store` | `TagsInputStore` | yes | |
|
|
51
|
+
|
|
52
|
+
### TagsInputRootShellOwnProps
|
|
53
|
+
|
|
54
|
+
| Member | Type | Required | Description |
|
|
55
|
+
| --- | --- | --- | --- |
|
|
56
|
+
| `className` | `string` | no | |
|
|
57
|
+
| `addOnPaste` | `boolean` | no | |
|
|
58
|
+
| `allowDuplicates` | `boolean` | no | |
|
|
59
|
+
| `defaultValue` | `readonly string[]` | no | |
|
|
60
|
+
| `delimiters` | `readonly string[]` | no | |
|
|
61
|
+
| `disabled` | `boolean` | no | |
|
|
62
|
+
| `id` | `string` | no | |
|
|
63
|
+
| `items` | `readonly string[]` | no | |
|
|
64
|
+
| `maxTags` | `number` | no | |
|
|
65
|
+
| `validate` | `(tag: string) => boolean` | no | |
|
|
66
|
+
|
|
67
|
+
### TagsInputRootControlledOwnProps
|
|
68
|
+
|
|
69
|
+
| Member | Type | Required | Description |
|
|
70
|
+
| --- | --- | --- | --- |
|
|
71
|
+
| `onValueChange` | `(tags: string[]) => void` | no | |
|
|
72
|
+
| `value` | `readonly string[]` | no | |
|
|
73
|
+
|
|
74
|
+
### TagsInputRootShellProps
|
|
75
|
+
|
|
76
|
+
Extends: `TagsInputRootShellOwnProps`
|
|
77
|
+
|
|
78
|
+
| Member | Type | Required | Description |
|
|
79
|
+
| --- | --- | --- | --- |
|
|
80
|
+
| `children` | `ReactNode` | no | |
|
|
81
|
+
|
|
82
|
+
### TagsInputRootProps
|
|
83
|
+
|
|
84
|
+
Extends: `TagsInputRootShellOwnProps`, `TagsInputRootControlledOwnProps`
|
|
85
|
+
|
|
86
|
+
| Member | Type | Required | Description |
|
|
87
|
+
| --- | --- | --- | --- |
|
|
88
|
+
| `children` | `ReactNode` | no | |
|
|
89
|
+
|
|
90
|
+
### TagsInputInputOwnProps
|
|
91
|
+
|
|
92
|
+
| Member | Type | Required | Description |
|
|
93
|
+
| --- | --- | --- | --- |
|
|
94
|
+
| `className` | `string` | no | |
|
|
95
|
+
| `placeholder` | `string` | no | |
|
|
96
|
+
|
|
97
|
+
### TagsInputListOwnProps
|
|
98
|
+
|
|
99
|
+
| Member | Type | Required | Description |
|
|
100
|
+
| --- | --- | --- | --- |
|
|
101
|
+
| `children` | `ReactNode` | no | |
|
|
102
|
+
| `className` | `string` | no | |
|
|
103
|
+
|
|
104
|
+
### TagsInputTagOwnProps
|
|
105
|
+
|
|
106
|
+
| Member | Type | Required | Description |
|
|
107
|
+
| --- | --- | --- | --- |
|
|
108
|
+
| `children` | `ReactNode` | no | |
|
|
109
|
+
| `className` | `string` | no | |
|
|
110
|
+
| `index` | `number` | yes | |
|
|
111
|
+
| `value` | `string` | yes | |
|
|
112
|
+
|
|
113
|
+
### TagsInputTagRemoveOwnProps
|
|
114
|
+
|
|
115
|
+
| Member | Type | Required | Description |
|
|
116
|
+
| --- | --- | --- | --- |
|
|
117
|
+
| `className` | `string` | no | |
|
|
118
|
+
| `index` | `number` | yes | |
|
|
119
|
+
|
|
120
|
+
## Other types
|
|
121
|
+
|
|
122
|
+
- `TagsInputInputProps<TAs>`: `RenderableProps<TAs, TagsInputInputOwnProps, { disabled: boolean }, HTMLInputElement>`
|
|
123
|
+
- `TagsInputTagProps<TAs>`: `RenderableProps<TAs, TagsInputTagOwnProps, { current: boolean }, HTMLElement>`
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# textarea
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/textarea`
|
|
5
|
+
- Tier 0 (RSC — zero client JavaScript); state source S1; native element `textarea`
|
|
6
|
+
- Without JavaScript: full
|
|
7
|
+
- Types file: `dist/components/textarea.d.ts`
|
|
8
|
+
- Note: field-sizing:content replaces the auto-grow JS. Baseline since Firefox 152.
|
|
9
|
+
|
|
10
|
+
## Exports
|
|
11
|
+
|
|
12
|
+
- Runtime: `Textarea`
|
|
13
|
+
- Types: `TextareaOwnProps`, `TextareaProps`
|
|
14
|
+
|
|
15
|
+
## Props and shapes
|
|
16
|
+
|
|
17
|
+
### TextareaOwnProps
|
|
18
|
+
|
|
19
|
+
| Member | Type | Required | Description |
|
|
20
|
+
| --- | --- | --- | --- |
|
|
21
|
+
| `value` | `string` | no | |
|
|
22
|
+
| `defaultValue` | `string` | no | |
|
|
23
|
+
| `onValueChange` | `(value: string) => void` | no | |
|
|
24
|
+
| `autoSize` | `boolean` | no | |
|
|
25
|
+
| `disabled` | `boolean` | no | |
|
|
26
|
+
| `readOnly` | `boolean` | no | |
|
|
27
|
+
| `invalid` | `boolean` | no | |
|
|
28
|
+
|
|
29
|
+
## Other types
|
|
30
|
+
|
|
31
|
+
- `TextareaProps<TAs>`: `RenderableProps<TAs, TextareaOwnProps, TextareaOwnProps, HTMLTextAreaElement>`
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# toast
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/toast`
|
|
5
|
+
- Tier 1 (RSC shell + thin client island); state source S1; native element `[popover] + aria-live`
|
|
6
|
+
- Without JavaScript: degraded-documented
|
|
7
|
+
- Types file: `dist/components/toast.d.ts`
|
|
8
|
+
|
|
9
|
+
## Exports
|
|
10
|
+
|
|
11
|
+
- Runtime: `Toast`, `ToastAction`, `ToastClose`, `ToastDescription`, `ToastProvider`, `ToastRoot`, `ToastTitle`, `ToastViewport`, `useToast`
|
|
12
|
+
- Types: `ToastActionOwnProps`, `ToastActionProps`, `ToastCloseOwnProps`, `ToastCloseProps`, `ToastDescriptionOwnProps`, `ToastProviderOwnProps`, `ToastRootOwnProps`, `ToastTitleOwnProps`, `ToastViewportOwnProps`, `ToastInput`, `ToastPriority`, `ToastRecord`, `ToastStore`
|
|
13
|
+
|
|
14
|
+
## Values
|
|
15
|
+
|
|
16
|
+
- `ToastPriority`: `"polite" | "assertive"`
|
|
17
|
+
|
|
18
|
+
## Props and shapes
|
|
19
|
+
|
|
20
|
+
### ToastAction
|
|
21
|
+
|
|
22
|
+
| Member | Type | Required | Description |
|
|
23
|
+
| --- | --- | --- | --- |
|
|
24
|
+
| `label` | `ReactNode` | yes | |
|
|
25
|
+
| `onClick` | `() => void` | yes | |
|
|
26
|
+
|
|
27
|
+
### ToastInput
|
|
28
|
+
|
|
29
|
+
| Member | Type | Required | Description |
|
|
30
|
+
| --- | --- | --- | --- |
|
|
31
|
+
| `action` | `ToastAction` | no | |
|
|
32
|
+
| `description` | `ReactNode` | no | |
|
|
33
|
+
| `duration` | `number` | no | |
|
|
34
|
+
| `id` | `string` | no | |
|
|
35
|
+
| `priority` | `ToastPriority` | no | |
|
|
36
|
+
| `title` | `ReactNode` | no | |
|
|
37
|
+
|
|
38
|
+
### ToastRecord
|
|
39
|
+
|
|
40
|
+
| Member | Type | Required | Description |
|
|
41
|
+
| --- | --- | --- | --- |
|
|
42
|
+
| `action` | `ToastAction` | no | |
|
|
43
|
+
| `description` | `ReactNode` | no | |
|
|
44
|
+
| `duration` | `number` | yes | |
|
|
45
|
+
| `id` | `string` | yes | |
|
|
46
|
+
| `priority` | `ToastPriority` | yes | |
|
|
47
|
+
| `title` | `ReactNode` | no | |
|
|
48
|
+
|
|
49
|
+
### TimerState
|
|
50
|
+
|
|
51
|
+
| Member | Type | Required | Description |
|
|
52
|
+
| --- | --- | --- | --- |
|
|
53
|
+
| `remaining` | `number` | yes | |
|
|
54
|
+
| `startedAt` | `number` | yes | |
|
|
55
|
+
| `timerId` | `ReturnType<typeof setTimeout> \| null` | yes | |
|
|
56
|
+
|
|
57
|
+
### ToastStoreOptions
|
|
58
|
+
|
|
59
|
+
| Member | Type | Required | Description |
|
|
60
|
+
| --- | --- | --- | --- |
|
|
61
|
+
| `limit` | `number` | no | |
|
|
62
|
+
|
|
63
|
+
### ToastStore
|
|
64
|
+
|
|
65
|
+
| Member | Type | Required | Description |
|
|
66
|
+
| --- | --- | --- | --- |
|
|
67
|
+
| `dismiss` | `(id: string) => void` | yes | |
|
|
68
|
+
| `enqueue` | `(input: ToastInput) => string` | yes | |
|
|
69
|
+
| `getAnnouncement` | `() => string` | yes | |
|
|
70
|
+
| `getAssertiveAnnouncement` | `() => string` | yes | |
|
|
71
|
+
| `getSnapshot` | `() => readonly ToastRecord[]` | yes | |
|
|
72
|
+
| `getServerSnapshot` | `() => readonly ToastRecord[]` | yes | |
|
|
73
|
+
| `pause` | `(id: string) => void` | yes | |
|
|
74
|
+
| `resume` | `(id: string) => void` | yes | |
|
|
75
|
+
| `subscribe` | `(listener: () => void) => () => void` | yes | |
|
|
76
|
+
|
|
77
|
+
### ToastContextValue
|
|
78
|
+
|
|
79
|
+
| Member | Type | Required | Description |
|
|
80
|
+
| --- | --- | --- | --- |
|
|
81
|
+
| `dismiss` | `(id: string) => void` | yes | |
|
|
82
|
+
| `pause` | `(id: string) => void` | yes | |
|
|
83
|
+
| `resume` | `(id: string) => void` | yes | |
|
|
84
|
+
| `store` | `ToastStore` | yes | |
|
|
85
|
+
|
|
86
|
+
### ToastProviderOwnProps
|
|
87
|
+
|
|
88
|
+
| Member | Type | Required | Description |
|
|
89
|
+
| --- | --- | --- | --- |
|
|
90
|
+
| `children` | `ReactNode` | no | |
|
|
91
|
+
| `limit` | `number` | no | |
|
|
92
|
+
|
|
93
|
+
### ToastViewportOwnProps
|
|
94
|
+
|
|
95
|
+
| Member | Type | Required | Description |
|
|
96
|
+
| --- | --- | --- | --- |
|
|
97
|
+
| `"aria-label"` | `string` | no | |
|
|
98
|
+
| `children` | `ReactNode` | no | |
|
|
99
|
+
| `className` | `string` | no | |
|
|
100
|
+
| `popover` | `"manual"` | no | Set by the live client viewport (@gunkin/uiify/components/toast/Toast.js) to `"manual"` so the queue's rendered surface sits in the top layer. The structural shell (this file's own re-exported ToastViewport, used directly by "Toast server shell" tests and any no-JS render) leaves it unset, since there is no queue-driven show/hide to wire up there. |
|
|
101
|
+
| `ref` | `Ref<HTMLElement>` | no | |
|
|
102
|
+
|
|
103
|
+
### ToastRootOwnProps
|
|
104
|
+
|
|
105
|
+
| Member | Type | Required | Description |
|
|
106
|
+
| --- | --- | --- | --- |
|
|
107
|
+
| `toast` | `ToastRecord` | yes | |
|
|
108
|
+
|
|
109
|
+
### ToastTitleOwnProps
|
|
110
|
+
|
|
111
|
+
| Member | Type | Required | Description |
|
|
112
|
+
| --- | --- | --- | --- |
|
|
113
|
+
| `children` | `ReactNode` | no | |
|
|
114
|
+
| `className` | `string` | no | |
|
|
115
|
+
|
|
116
|
+
### ToastDescriptionOwnProps
|
|
117
|
+
|
|
118
|
+
| Member | Type | Required | Description |
|
|
119
|
+
| --- | --- | --- | --- |
|
|
120
|
+
| `children` | `ReactNode` | no | |
|
|
121
|
+
| `className` | `string` | no | |
|
|
122
|
+
|
|
123
|
+
### ToastActionOwnProps
|
|
124
|
+
|
|
125
|
+
| Member | Type | Required | Description |
|
|
126
|
+
| --- | --- | --- | --- |
|
|
127
|
+
| `children` | `ReactNode` | no | |
|
|
128
|
+
| `className` | `string` | no | |
|
|
129
|
+
|
|
130
|
+
### ToastActionProps
|
|
131
|
+
|
|
132
|
+
Extends: `ToastActionOwnProps`
|
|
133
|
+
|
|
134
|
+
| Member | Type | Required | Description |
|
|
135
|
+
| --- | --- | --- | --- |
|
|
136
|
+
| `onClick` | `(event: MouseEvent<HTMLButtonElement>) => void` | no | |
|
|
137
|
+
|
|
138
|
+
### ToastCloseOwnProps
|
|
139
|
+
|
|
140
|
+
| Member | Type | Required | Description |
|
|
141
|
+
| --- | --- | --- | --- |
|
|
142
|
+
| `children` | `ReactNode` | no | |
|
|
143
|
+
| `className` | `string` | no | |
|
|
144
|
+
|
|
145
|
+
### ToastCloseProps
|
|
146
|
+
|
|
147
|
+
Extends: `ToastCloseOwnProps`
|
|
148
|
+
|
|
149
|
+
| Member | Type | Required | Description |
|
|
150
|
+
| --- | --- | --- | --- |
|
|
151
|
+
| `onClick` | `(event: MouseEvent<HTMLButtonElement>) => void` | no | |
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# toggle-group
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/toggle-group`
|
|
5
|
+
- Tier 0 (RSC — zero client JavaScript); state source S1; native element `input[type=radio|checkbox]`
|
|
6
|
+
- Without JavaScript: full
|
|
7
|
+
- Types file: `dist/components/toggle-group.d.ts`
|
|
8
|
+
- Note: Built on @gunkin/uiify/elements/choice.
|
|
9
|
+
|
|
10
|
+
## Exports
|
|
11
|
+
|
|
12
|
+
- Runtime: `ToggleGroup`
|
|
13
|
+
- Types: `ToggleGroupClientProps`, `ToggleGroupItem`, `ToggleGroupProps`
|
|
14
|
+
|
|
15
|
+
## Props and shapes
|
|
16
|
+
|
|
17
|
+
### ToggleGroupProps
|
|
18
|
+
|
|
19
|
+
| Member | Type | Required | Description |
|
|
20
|
+
| --- | --- | --- | --- |
|
|
21
|
+
| `id` | `string` | yes | |
|
|
22
|
+
| `type` | `"single" \| "multiple"` | no | |
|
|
23
|
+
| `items` | `readonly ToggleGroupItem[]` | yes | |
|
|
24
|
+
| `defaultValue` | `string \| readonly string[]` | no | |
|
|
25
|
+
| `disabled` | `boolean` | no | |
|
|
26
|
+
| `orientation` | `ChoiceOrientation` | no | |
|
|
27
|
+
| `size` | `"sm" \| "md" \| "lg"` | no | Button size of each item; `md` metrics when omitted. |
|
|
28
|
+
| `className` | `string` | no | |
|
|
29
|
+
| `"aria-label"` | `string` | no | |
|
|
30
|
+
| `"aria-labelledby"` | `string` | no | |
|
|
31
|
+
|
|
32
|
+
### ToggleGroupClientProps
|
|
33
|
+
|
|
34
|
+
Extends: `ToggleGroupProps`
|
|
35
|
+
|
|
36
|
+
| Member | Type | Required | Description |
|
|
37
|
+
| --- | --- | --- | --- |
|
|
38
|
+
| `value` | `string \| readonly string[]` | no | |
|
|
39
|
+
| `onValueChange` | `(value: string \| readonly string[]) => void` | no | |
|
|
40
|
+
|
|
41
|
+
## Other types
|
|
42
|
+
|
|
43
|
+
- `ToggleGroupItem`: `ChoiceItem`
|
|
44
|
+
|
|
45
|
+
## Sub-entries
|
|
46
|
+
|
|
47
|
+
### `@gunkin/uiify/components/toggle-group/client`
|
|
48
|
+
|
|
49
|
+
- Runtime: `ToggleGroupClient`
|
|
50
|
+
- Types: `ToggleGroupClientProps`
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# toggle
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/toggle`
|
|
5
|
+
- Tier 0 (RSC — zero client JavaScript); state source S1; native element `input[type=checkbox]`
|
|
6
|
+
- Without JavaScript: full
|
|
7
|
+
- Types file: `dist/components/toggle.d.ts`
|
|
8
|
+
- Note: Native checkbox + label toggle; browser owns pressed state.
|
|
9
|
+
|
|
10
|
+
## Exports
|
|
11
|
+
|
|
12
|
+
- Runtime: `Toggle`
|
|
13
|
+
- Types: `ToggleProps`
|
|
14
|
+
|
|
15
|
+
## Props and shapes
|
|
16
|
+
|
|
17
|
+
### ToggleProps
|
|
18
|
+
|
|
19
|
+
| Member | Type | Required | Description |
|
|
20
|
+
| --- | --- | --- | --- |
|
|
21
|
+
| `id` | `string` | yes | |
|
|
22
|
+
| `label` | `ReactNode` | yes | |
|
|
23
|
+
| `pressed` | `boolean` | no | |
|
|
24
|
+
| `defaultPressed` | `boolean` | no | |
|
|
25
|
+
| `disabled` | `boolean` | no | |
|
|
26
|
+
| `className` | `string` | no | |
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# toolbar
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/toolbar`
|
|
5
|
+
- Tier 1 (RSC shell + thin client island); state source none; native element `div[role=toolbar]`
|
|
6
|
+
- Without JavaScript: degraded-documented
|
|
7
|
+
- Types file: `dist/components/toolbar.d.ts`
|
|
8
|
+
|
|
9
|
+
## Exports
|
|
10
|
+
|
|
11
|
+
- Runtime: `Toolbar`
|
|
12
|
+
- Types: `ToolbarButtonOwnProps`, `ToolbarButtonProps`, `ToolbarLinkOwnProps`, `ToolbarLinkProps`, `ToolbarRootOwnProps`, `ToolbarRootProps`, `ToolbarSeparatorOwnProps`, `ToolbarSeparatorProps`, `ToolbarToggleGroupProps`
|
|
13
|
+
|
|
14
|
+
## Props and shapes
|
|
15
|
+
|
|
16
|
+
### ToolbarRootOwnProps
|
|
17
|
+
|
|
18
|
+
| Member | Type | Required | Description |
|
|
19
|
+
| --- | --- | --- | --- |
|
|
20
|
+
| `dir` | `Direction` | no | |
|
|
21
|
+
| `loop` | `boolean` | no | |
|
|
22
|
+
| `orientation` | `RovingFocusOrientation` | no | |
|
|
23
|
+
|
|
24
|
+
### ToolbarRootProps
|
|
25
|
+
|
|
26
|
+
Extends: `ToolbarRootOwnProps`, `Omit<HTMLAttributes<HTMLDivElement>, keyof ToolbarRootOwnProps>`
|
|
27
|
+
|
|
28
|
+
No own members.
|
|
29
|
+
|
|
30
|
+
### ToolbarButtonOwnProps
|
|
31
|
+
|
|
32
|
+
| Member | Type | Required | Description |
|
|
33
|
+
| --- | --- | --- | --- |
|
|
34
|
+
| `selected` | `boolean` | no | Toggle state of the button: reported as aria-pressed and styled as selected. |
|
|
35
|
+
| `children` | `ReactNode` | no | |
|
|
36
|
+
| `className` | `string` | no | |
|
|
37
|
+
| `disabled` | `boolean` | no | |
|
|
38
|
+
|
|
39
|
+
### ToolbarButtonProps
|
|
40
|
+
|
|
41
|
+
Extends: `ToolbarButtonOwnProps`, `Omit<HTMLAttributes<HTMLButtonElement>, keyof ToolbarButtonOwnProps | "disabled">`
|
|
42
|
+
|
|
43
|
+
No own members.
|
|
44
|
+
|
|
45
|
+
### ToolbarLinkOwnProps
|
|
46
|
+
|
|
47
|
+
| Member | Type | Required | Description |
|
|
48
|
+
| --- | --- | --- | --- |
|
|
49
|
+
| `children` | `ReactNode` | no | |
|
|
50
|
+
| `className` | `string` | no | |
|
|
51
|
+
| `href` | `string` | yes | |
|
|
52
|
+
|
|
53
|
+
### ToolbarLinkProps
|
|
54
|
+
|
|
55
|
+
Extends: `ToolbarLinkOwnProps`, `Omit<HTMLAttributes<HTMLAnchorElement>, keyof ToolbarLinkOwnProps | "href">`
|
|
56
|
+
|
|
57
|
+
No own members.
|
|
58
|
+
|
|
59
|
+
### ToolbarSeparatorOwnProps
|
|
60
|
+
|
|
61
|
+
| Member | Type | Required | Description |
|
|
62
|
+
| --- | --- | --- | --- |
|
|
63
|
+
| `className` | `string` | no | |
|
|
64
|
+
| `orientation` | `"horizontal" \| "vertical"` | no | |
|
|
65
|
+
|
|
66
|
+
## Other types
|
|
67
|
+
|
|
68
|
+
- `ToolbarSeparatorProps`: `ToolbarSeparatorOwnProps & Omit<HTMLAttributes<HTMLHRElement>, keyof ToolbarSeparatorOwnProps>`
|
|
69
|
+
- `ToolbarToggleGroupProps`: `ToggleGroupProps`
|