@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,274 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# carousel
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/carousel`
|
|
5
|
+
- Tier 2 (Client component — pre-hydration SSR); state source none; native element `section > div[scroll-snap]`
|
|
6
|
+
- Without JavaScript: pre-hydration-only
|
|
7
|
+
- Types file: `dist/components/carousel.d.ts`
|
|
8
|
+
- Note: The documented interactive carousel uses /client and requires hydration for synchronized controls. The base entry remains a native no-JS scroller with CSS Scroll Snap and fragment navigation; /fade adds client-driven CSS transitions.
|
|
9
|
+
|
|
10
|
+
## Exports
|
|
11
|
+
|
|
12
|
+
- Runtime: `Carousel`
|
|
13
|
+
- Types: `CarouselAxis`, `CarouselItem`, `CarouselLabels`, `CarouselProps`, `CarouselStyle`
|
|
14
|
+
|
|
15
|
+
## Values
|
|
16
|
+
|
|
17
|
+
- `CarouselAxis`: `"inline" | "block"`
|
|
18
|
+
- `CarouselReason`: `"previous" | "next" | "dot" | "command" | "scroll" | "drag" | "autoplay" | "controlled" | "items"`
|
|
19
|
+
|
|
20
|
+
## Props and shapes
|
|
21
|
+
|
|
22
|
+
### CarouselItem
|
|
23
|
+
|
|
24
|
+
| Member | Type | Required | Description |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
| `id` | `string` | yes | |
|
|
27
|
+
| `label` | `string` | yes | |
|
|
28
|
+
| `children` | `ReactNode` | yes | |
|
|
29
|
+
| `className` | `string` | no | |
|
|
30
|
+
|
|
31
|
+
### CarouselLabels
|
|
32
|
+
|
|
33
|
+
| Member | Type | Required | Description |
|
|
34
|
+
| --- | --- | --- | --- |
|
|
35
|
+
| `previous` | `string` | yes | |
|
|
36
|
+
| `next` | `string` | yes | |
|
|
37
|
+
| `goTo` | `string` | yes | |
|
|
38
|
+
| `navigation` | `string` | yes | |
|
|
39
|
+
| `start` | `string` | yes | |
|
|
40
|
+
| `stop` | `string` | yes | |
|
|
41
|
+
| `of` | `string` | yes | |
|
|
42
|
+
|
|
43
|
+
### CarouselIcons
|
|
44
|
+
|
|
45
|
+
Visible content for the client entries' buttons. Empty by default: `labels` already supplies each button's accessible name, so a consumer supplies whatever it wants to see — an icon, a glyph, a word — without the component shipping one of its own.
|
|
46
|
+
|
|
47
|
+
| Member | Type | Required | Description |
|
|
48
|
+
| --- | --- | --- | --- |
|
|
49
|
+
| `previous` | `ReactNode` | no | |
|
|
50
|
+
| `next` | `ReactNode` | no | |
|
|
51
|
+
|
|
52
|
+
### CarouselStyle
|
|
53
|
+
|
|
54
|
+
Extends: `CSSProperties`
|
|
55
|
+
|
|
56
|
+
| Member | Type | Required | Description |
|
|
57
|
+
| --- | --- | --- | --- |
|
|
58
|
+
| `"--uiify-carousel-slide-size"` | `string` | no | |
|
|
59
|
+
| `"--uiify-carousel-gap"` | `string` | no | |
|
|
60
|
+
| `"--uiify-carousel-fade-duration"` | `string` | no | |
|
|
61
|
+
|
|
62
|
+
### CarouselProps
|
|
63
|
+
|
|
64
|
+
| Member | Type | Required | Description |
|
|
65
|
+
| --- | --- | --- | --- |
|
|
66
|
+
| `id` | `string` | yes | |
|
|
67
|
+
| `items` | `readonly CarouselItem[]` | yes | |
|
|
68
|
+
| `"aria-label"` | `string` | yes | |
|
|
69
|
+
| `axis` | `CarouselAxis` | no | |
|
|
70
|
+
| `dir` | `"ltr" \| "rtl"` | no | |
|
|
71
|
+
| `navigation` | `boolean` | no | |
|
|
72
|
+
| `pagination` | `boolean` | no | |
|
|
73
|
+
| `className` | `string` | no | |
|
|
74
|
+
| `style` | `CarouselStyle` | no | |
|
|
75
|
+
| `labels` | `Partial<CarouselLabels>` | no | |
|
|
76
|
+
| `icons` | `CarouselIcons` | no | |
|
|
77
|
+
|
|
78
|
+
### CarouselChange
|
|
79
|
+
|
|
80
|
+
| Member | Type | Required | Description |
|
|
81
|
+
| --- | --- | --- | --- |
|
|
82
|
+
| `previousIndex` | `number` | yes | |
|
|
83
|
+
| `index` | `number` | yes | |
|
|
84
|
+
| `reason` | `CarouselReason` | yes | |
|
|
85
|
+
|
|
86
|
+
### CarouselAutoplayOptions
|
|
87
|
+
|
|
88
|
+
| Member | Type | Required | Description |
|
|
89
|
+
| --- | --- | --- | --- |
|
|
90
|
+
| `delay` | `number` | no | |
|
|
91
|
+
| `paused` | `boolean` | no | |
|
|
92
|
+
| `cycles` | `number` | no | |
|
|
93
|
+
| `stopOnInteraction` | `boolean` | no | |
|
|
94
|
+
|
|
95
|
+
### CarouselClientProps
|
|
96
|
+
|
|
97
|
+
Extends: `CarouselProps`
|
|
98
|
+
|
|
99
|
+
| Member | Type | Required | Description |
|
|
100
|
+
| --- | --- | --- | --- |
|
|
101
|
+
| `ref` | `Ref<CarouselClientHandle>` | no | |
|
|
102
|
+
| `defaultValue` | `number` | no | |
|
|
103
|
+
| `value` | `number` | no | |
|
|
104
|
+
| `rewind` | `boolean` | no | |
|
|
105
|
+
| `mouseDrag` | `boolean` | no | |
|
|
106
|
+
| `autoplay` | `boolean \| CarouselAutoplayOptions` | no | |
|
|
107
|
+
| `onSelect` | `(index: number, detail: CarouselChange) => void` | no | |
|
|
108
|
+
| `beforeChange` | `(detail: CarouselChange) => void` | no | |
|
|
109
|
+
| `afterChange` | `(detail: CarouselChange) => void` | no | |
|
|
110
|
+
| `onSwipe` | `(detail: CarouselChange) => void` | no | |
|
|
111
|
+
|
|
112
|
+
### FadeCarouselClientProps
|
|
113
|
+
|
|
114
|
+
Extends: `Omit<CarouselClientProps, "axis">`
|
|
115
|
+
|
|
116
|
+
| Member | Type | Required | Description |
|
|
117
|
+
| --- | --- | --- | --- |
|
|
118
|
+
| `swipe` | `boolean` | no | |
|
|
119
|
+
|
|
120
|
+
### CarouselClientHandle
|
|
121
|
+
|
|
122
|
+
| Member | Type | Required | Description |
|
|
123
|
+
| --- | --- | --- | --- |
|
|
124
|
+
| `next` | `() => void` | yes | |
|
|
125
|
+
| `previous` | `() => void` | yes | |
|
|
126
|
+
| `goTo` | `(index: number) => void` | yes | |
|
|
127
|
+
| `start` | `() => void` | yes | |
|
|
128
|
+
| `stop` | `() => void` | yes | |
|
|
129
|
+
| `reset` | `() => void` | yes | |
|
|
130
|
+
|
|
131
|
+
### CarouselPage
|
|
132
|
+
|
|
133
|
+
| Member | Type | Required | Description |
|
|
134
|
+
| --- | --- | --- | --- |
|
|
135
|
+
| `index` | `number` | yes | |
|
|
136
|
+
| `offset` | `number` | yes | |
|
|
137
|
+
|
|
138
|
+
### CarouselSnapshot
|
|
139
|
+
|
|
140
|
+
| Member | Type | Required | Description |
|
|
141
|
+
| --- | --- | --- | --- |
|
|
142
|
+
| `settledIndex` | `number` | yes | |
|
|
143
|
+
| `ready` | `boolean` | yes | |
|
|
144
|
+
| `index` | `number` | yes | |
|
|
145
|
+
| `requestedIndex` | `number \| null` | yes | |
|
|
146
|
+
| `settledChange` | `CarouselChange \| null` | yes | |
|
|
147
|
+
| `pages` | `readonly CarouselPage[]` | yes | |
|
|
148
|
+
| `visibleIndices` | `readonly number[]` | yes | |
|
|
149
|
+
| `atStart` | `boolean` | yes | |
|
|
150
|
+
| `atEnd` | `boolean` | yes | |
|
|
151
|
+
| `moving` | `boolean` | yes | |
|
|
152
|
+
| `interacting` | `boolean` | yes | |
|
|
153
|
+
|
|
154
|
+
### CarouselControllerOptions
|
|
155
|
+
|
|
156
|
+
| Member | Type | Required | Description |
|
|
157
|
+
| --- | --- | --- | --- |
|
|
158
|
+
| `defaultValue` | `number` | yes | |
|
|
159
|
+
| `value` | `number` | no | |
|
|
160
|
+
| `rewind` | `boolean` | yes | |
|
|
161
|
+
| `onSelect` | `CarouselClientProps["onSelect"]` | no | |
|
|
162
|
+
| `beforeChange` | `CarouselClientProps["beforeChange"]` | no | |
|
|
163
|
+
| `afterChange` | `CarouselClientProps["afterChange"]` | no | |
|
|
164
|
+
| `onSwipe` | `CarouselClientProps["onSwipe"]` | no | |
|
|
165
|
+
|
|
166
|
+
### CarouselController
|
|
167
|
+
|
|
168
|
+
| Member | Type | Required | Description |
|
|
169
|
+
| --- | --- | --- | --- |
|
|
170
|
+
| `getSnapshot` | `() => CarouselSnapshot` | yes | |
|
|
171
|
+
| `getGeometry` | `() => CarouselGeometry \| undefined` | yes | |
|
|
172
|
+
| `subscribe` | `(listener: () => void) => () => void` | yes | |
|
|
173
|
+
| `goTo` | `(index: number, reason: CarouselReason) => void` | yes | |
|
|
174
|
+
| `next` | `(reason: CarouselReason) => void` | yes | |
|
|
175
|
+
| `previous` | `(reason: CarouselReason) => void` | yes | |
|
|
176
|
+
| `setInteracting` | `(active: boolean) => void` | yes | |
|
|
177
|
+
| `update` | `(options: CarouselControllerOptions) => void` | yes | |
|
|
178
|
+
| `refresh` | `() => void` | yes | |
|
|
179
|
+
| `destroy` | `() => void` | yes | |
|
|
180
|
+
|
|
181
|
+
### CarouselGeometry
|
|
182
|
+
|
|
183
|
+
| Member | Type | Required | Description |
|
|
184
|
+
| --- | --- | --- | --- |
|
|
185
|
+
| `physicalAxis` | `"x" \| "y"` | yes | |
|
|
186
|
+
| `sign` | `1 \| -1` | yes | |
|
|
187
|
+
| `viewportSize` | `number` | yes | |
|
|
188
|
+
| `currentOffset` | `number` | yes | |
|
|
189
|
+
| `itemStarts` | `readonly number[]` | yes | |
|
|
190
|
+
| `itemSizes` | `readonly number[]` | yes | |
|
|
191
|
+
|
|
192
|
+
### CarouselObservation
|
|
193
|
+
|
|
194
|
+
| Member | Type | Required | Description |
|
|
195
|
+
| --- | --- | --- | --- |
|
|
196
|
+
| `geometry` | `CarouselGeometry` | yes | |
|
|
197
|
+
| `visibleIndices` | `readonly number[]` | yes | |
|
|
198
|
+
|
|
199
|
+
### CarouselObserver
|
|
200
|
+
|
|
201
|
+
| Member | Type | Required | Description |
|
|
202
|
+
| --- | --- | --- | --- |
|
|
203
|
+
| `watch` | `(receive: (index: number, visible: readonly number[]) => void) => void` | yes | |
|
|
204
|
+
| `measure` | `(receive: (value: CarouselObservation) => void) => void` | yes | |
|
|
205
|
+
| `destroy` | `() => void` | yes | |
|
|
206
|
+
|
|
207
|
+
### CarouselAutoplaySnapshot
|
|
208
|
+
|
|
209
|
+
| Member | Type | Required | Description |
|
|
210
|
+
| --- | --- | --- | --- |
|
|
211
|
+
| `requested` | `boolean` | yes | |
|
|
212
|
+
| `playing` | `boolean` | yes | |
|
|
213
|
+
| `completedAdvances` | `number` | yes | |
|
|
214
|
+
|
|
215
|
+
### CarouselAutoplayController
|
|
216
|
+
|
|
217
|
+
| Member | Type | Required | Description |
|
|
218
|
+
| --- | --- | --- | --- |
|
|
219
|
+
| `getSnapshot` | `() => CarouselAutoplaySnapshot` | yes | |
|
|
220
|
+
| `subscribe` | `(listener: () => void) => () => void` | yes | |
|
|
221
|
+
| `start` | `() => void` | yes | |
|
|
222
|
+
| `stop` | `() => void` | yes | |
|
|
223
|
+
| `reset` | `() => void` | yes | |
|
|
224
|
+
| `update` | `(options: CarouselAutoplayOptions) => void` | yes | |
|
|
225
|
+
| `destroy` | `() => void` | yes | |
|
|
226
|
+
|
|
227
|
+
### CarouselPresentation
|
|
228
|
+
|
|
229
|
+
| Member | Type | Required | Description |
|
|
230
|
+
| --- | --- | --- | --- |
|
|
231
|
+
| `mode` | `"scroll" \| "fade"` | yes | |
|
|
232
|
+
| `snapshot` | `CarouselSnapshot` | yes | |
|
|
233
|
+
| `autoplay` | `CarouselAutoplaySnapshot` | no | |
|
|
234
|
+
| `preserveFallbackFocus` | `boolean` | yes | |
|
|
235
|
+
| `mounted` | `boolean` | yes | True once mounted client-side, even before the controller reports `ready`. |
|
|
236
|
+
|
|
237
|
+
### CarouselMarkupProps
|
|
238
|
+
|
|
239
|
+
| Member | Type | Required | Description |
|
|
240
|
+
| --- | --- | --- | --- |
|
|
241
|
+
| `base` | `CarouselProps` | yes | |
|
|
242
|
+
| `rootRef` | `Ref<HTMLElement>` | no | |
|
|
243
|
+
| `presentation` | `CarouselPresentation` | no | |
|
|
244
|
+
|
|
245
|
+
### CarouselClientViewProps
|
|
246
|
+
|
|
247
|
+
| Member | Type | Required | Description |
|
|
248
|
+
| --- | --- | --- | --- |
|
|
249
|
+
| `base` | `CarouselProps` | yes | |
|
|
250
|
+
| `rootRef` | `Ref<HTMLElement>` | yes | |
|
|
251
|
+
| `mode` | `"scroll" \| "fade"` | yes | |
|
|
252
|
+
| `controller` | `CarouselController` | no | |
|
|
253
|
+
| `autoplay` | `CarouselAutoplayController` | no | |
|
|
254
|
+
|
|
255
|
+
### CarouselCommandController
|
|
256
|
+
|
|
257
|
+
Actions accepted by native commandfor buttons targeting the root.
|
|
258
|
+
|
|
259
|
+
| Member | Type | Required | Description |
|
|
260
|
+
| --- | --- | --- | --- |
|
|
261
|
+
| `next` | `() => void` | yes | |
|
|
262
|
+
| `previous` | `() => void` | yes | |
|
|
263
|
+
|
|
264
|
+
## Sub-entries
|
|
265
|
+
|
|
266
|
+
### `@gunkin/uiify/components/carousel/client`
|
|
267
|
+
|
|
268
|
+
- Runtime: `CarouselClient`
|
|
269
|
+
- Types: `CarouselClientProps`, `CarouselClientHandle`, `CarouselAutoplayOptions`, `CarouselChange`, `CarouselReason`
|
|
270
|
+
|
|
271
|
+
### `@gunkin/uiify/components/carousel/fade`
|
|
272
|
+
|
|
273
|
+
- Runtime: `FadeCarouselClient`
|
|
274
|
+
- Types: `CarouselClientHandle`, `FadeCarouselClientProps`
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# checkbox
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/checkbox`
|
|
5
|
+
- Tier 0 (RSC — zero client JavaScript); state source S1; native element `input[type=checkbox]`
|
|
6
|
+
- Without JavaScript: full
|
|
7
|
+
- Types file: `dist/components/checkbox.d.ts`
|
|
8
|
+
- Note: Native checkbox + label; default entry ships controlled callbacks with use client.
|
|
9
|
+
|
|
10
|
+
## Exports
|
|
11
|
+
|
|
12
|
+
- Runtime: `Checkbox`
|
|
13
|
+
- Types: `CheckboxProps`, `CheckedState`
|
|
14
|
+
|
|
15
|
+
## Props and shapes
|
|
16
|
+
|
|
17
|
+
### CheckboxProps
|
|
18
|
+
|
|
19
|
+
| Member | Type | Required | Description |
|
|
20
|
+
| --- | --- | --- | --- |
|
|
21
|
+
| `id` | `string` | yes | |
|
|
22
|
+
| `label` | `ReactNode` | no | |
|
|
23
|
+
| `checked` | `CheckedState` | no | |
|
|
24
|
+
| `defaultChecked` | `boolean` | no | |
|
|
25
|
+
| `disabled` | `boolean` | no | |
|
|
26
|
+
| `className` | `string` | no | |
|
|
27
|
+
| `onCheckedChange` | `(checked: boolean) => void` | no | |
|
|
28
|
+
| `"aria-label"` | `string` | no | |
|
|
29
|
+
|
|
30
|
+
## Other types
|
|
31
|
+
|
|
32
|
+
- `CheckedState`: `boolean | "indeterminate"`
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# collapsible
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/collapsible`
|
|
5
|
+
- Tier 0 (RSC — zero client JavaScript); state source S1; native element `details`
|
|
6
|
+
- Without JavaScript: full
|
|
7
|
+
- Types file: `dist/components/collapsible.d.ts`
|
|
8
|
+
- Note: Native details/summary disclosure. Built on @gunkin/uiify/elements/details.
|
|
9
|
+
|
|
10
|
+
## Exports
|
|
11
|
+
|
|
12
|
+
- Runtime: `Collapsible`
|
|
13
|
+
- Types: `CollapsibleProps`
|
|
14
|
+
|
|
15
|
+
## Props and shapes
|
|
16
|
+
|
|
17
|
+
### CollapsibleProps
|
|
18
|
+
|
|
19
|
+
| Member | Type | Required | Description |
|
|
20
|
+
| --- | --- | --- | --- |
|
|
21
|
+
| `id` | `string` | yes | |
|
|
22
|
+
| `label` | `ReactNode` | yes | |
|
|
23
|
+
| `content` | `ReactNode` | yes | |
|
|
24
|
+
| `defaultOpen` | `boolean` | no | |
|
|
25
|
+
| `disabled` | `boolean` | no | |
|
|
26
|
+
| `className` | `string` | no | |
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# color-picker
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/color-picker`
|
|
5
|
+
- Tier 1 (RSC shell + thin client island); state source S1; native element `input[type=color]`
|
|
6
|
+
- Without JavaScript: degraded-documented
|
|
7
|
+
- Types file: `dist/components/color-picker.d.ts`
|
|
8
|
+
|
|
9
|
+
## Exports
|
|
10
|
+
|
|
11
|
+
- Runtime: `ColorPicker`
|
|
12
|
+
- Types: `ColorPickerProps`, `ColorSpace`
|
|
13
|
+
|
|
14
|
+
## Values
|
|
15
|
+
|
|
16
|
+
- `ColorSpace`: `"limited-srgb" | "display-p3"`
|
|
17
|
+
|
|
18
|
+
## Props and shapes
|
|
19
|
+
|
|
20
|
+
### ColorPickerOwnProps
|
|
21
|
+
|
|
22
|
+
| Member | Type | Required | Description |
|
|
23
|
+
| --- | --- | --- | --- |
|
|
24
|
+
| `alpha` | `boolean` | no | |
|
|
25
|
+
| `colorSpace` | `ColorSpace` | no | |
|
|
26
|
+
| `defaultValue` | `string` | no | |
|
|
27
|
+
| `label` | `string` | yes | |
|
|
28
|
+
| `onValueChange` | `(value: string) => void` | no | |
|
|
29
|
+
| `value` | `string` | no | |
|
|
30
|
+
|
|
31
|
+
## Other types
|
|
32
|
+
|
|
33
|
+
- `ColorPickerProps`: `Omit<ComponentPropsWithRef<"input">, | "alpha" | "className" | "colorSpace" | "defaultValue" | "onChange" | "ref" | "style" | "type" | "value"> & ColorPickerOwnProps & { readonly className?: string; readonly onChange?: ChangeEventHandler<HTMLInputElement>; readonly ref?: Ref<HTMLInputElement>; readonly style?: CSSProperties; }`
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# combobox
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/combobox`
|
|
5
|
+
- Tier 2 (Client component — pre-hydration SSR); state source S2; native element `input+listbox`
|
|
6
|
+
- Without JavaScript: pre-hydration-only
|
|
7
|
+
- Types file: `dist/components/combobox.d.ts`
|
|
8
|
+
|
|
9
|
+
## Exports
|
|
10
|
+
|
|
11
|
+
- Runtime: `Combobox`, `ComboboxControl`, `ComboboxContent`, `ComboboxEmpty`, `ComboboxInput`, `ComboboxItem`, `ComboboxRoot`, `ComboboxTags`, `ComboboxTrigger`
|
|
12
|
+
- Types: `ComboboxContentOwnProps`, `ComboboxControlOwnProps`, `ComboboxControlProps`, `ComboboxEmptyOwnProps`, `ComboboxFilterFn`, `ComboboxInputOwnProps`, `ComboboxInputProps`, `ComboboxItemData`, `ComboboxItemOwnProps`, `ComboboxRootControlledOwnProps`, `ComboboxRootShellOwnProps`, `ComboboxRootShellProps`, `ComboboxRootProps`, `ComboboxTagsOwnProps`, `ComboboxTagsProps`, `ComboboxTriggerOwnProps`, `ComboboxTriggerProps`
|
|
13
|
+
|
|
14
|
+
## Values
|
|
15
|
+
|
|
16
|
+
- `ActiveMoveDirection`: `"first" | "last" | "next" | "prev"`
|
|
17
|
+
|
|
18
|
+
## Props and shapes
|
|
19
|
+
|
|
20
|
+
### ComboboxItemData
|
|
21
|
+
|
|
22
|
+
| Member | Type | Required | Description |
|
|
23
|
+
| --- | --- | --- | --- |
|
|
24
|
+
| `disabled` | `boolean` | no | |
|
|
25
|
+
| `label` | `string` | yes | |
|
|
26
|
+
| `value` | `string` | yes | |
|
|
27
|
+
|
|
28
|
+
### ComboboxActiveStore
|
|
29
|
+
|
|
30
|
+
| Member | Type | Required | Description |
|
|
31
|
+
| --- | --- | --- | --- |
|
|
32
|
+
| `getActiveId` | `() => string \| null` | yes | |
|
|
33
|
+
| `isActive` | `(id: string) => boolean` | yes | |
|
|
34
|
+
| `setActiveId` | `(next: string \| null) => void` | yes | |
|
|
35
|
+
| `subscribe` | `(listener: () => void) => () => void` | yes | |
|
|
36
|
+
| `subscribeItem` | `(id: string, listener: () => void) => () => void` | yes | |
|
|
37
|
+
|
|
38
|
+
### ComboboxMultiValueOptions
|
|
39
|
+
|
|
40
|
+
| Member | Type | Required | Description |
|
|
41
|
+
| --- | --- | --- | --- |
|
|
42
|
+
| `addOnPaste` | `boolean` | no | |
|
|
43
|
+
| `allowCustomValue` | `boolean` | no | |
|
|
44
|
+
| `delimiters` | `readonly string[]` | no | |
|
|
45
|
+
| `maxValues` | `number` | no | |
|
|
46
|
+
| `validateValue` | `(value: string) => boolean` | no | |
|
|
47
|
+
|
|
48
|
+
### ComboboxContextValue
|
|
49
|
+
|
|
50
|
+
| Member | Type | Required | Description |
|
|
51
|
+
| --- | --- | --- | --- |
|
|
52
|
+
| `activeStore` | `ComboboxActiveStore` | yes | |
|
|
53
|
+
| `addOnPaste` | `boolean` | yes | |
|
|
54
|
+
| `anchorProps` | `UseAnchorPositionReturn["anchorProps"]` | yes | |
|
|
55
|
+
| `anchorRef` | `UseAnchorPositionReturn["anchorRef"]` | yes | |
|
|
56
|
+
| `close` | `() => void` | yes | |
|
|
57
|
+
| `filterFn` | `ComboboxFilterFn` | yes | |
|
|
58
|
+
| `inputNode` | `HTMLElement \| null` | yes | |
|
|
59
|
+
| `inputValue` | `string` | yes | |
|
|
60
|
+
| `items` | `readonly ComboboxItemData[]` | yes | |
|
|
61
|
+
| `listboxId` | `string` | yes | |
|
|
62
|
+
| `delimiters` | `readonly string[]` | yes | |
|
|
63
|
+
| `multiple` | `boolean` | yes | |
|
|
64
|
+
| `selectedValues` | `readonly string[]` | yes | |
|
|
65
|
+
| `getValueLabel` | `(value: string) => string` | yes | |
|
|
66
|
+
| `isValueSelected` | `(value: string) => boolean` | yes | |
|
|
67
|
+
| `toggleValue` | `(item: ComboboxItemData) => void` | yes | |
|
|
68
|
+
| `removeValue` | `(value: string) => void` | yes | |
|
|
69
|
+
| `commitValue` | `(value: string) => boolean` | yes | |
|
|
70
|
+
| `open` | `() => void` | yes | |
|
|
71
|
+
| `openState` | `boolean` | yes | |
|
|
72
|
+
| `popupProps` | `UsePopoverReturn["popupProps"]` | yes | |
|
|
73
|
+
| `popupRef` | `UsePopoverReturn["popupRef"]` | yes | |
|
|
74
|
+
| `positionerProps` | `UseAnchorPositionReturn["positionerProps"]` | yes | |
|
|
75
|
+
| `positionerRef` | `UseAnchorPositionReturn["positionerRef"]` | yes | |
|
|
76
|
+
| `selectItem` | `(item: ComboboxItemData) => void` | yes | |
|
|
77
|
+
| `setInputElement` | `(element: HTMLElement \| null) => void` | yes | |
|
|
78
|
+
| `setInputValue` | `(value: string) => void` | yes | |
|
|
79
|
+
| `value` | `string \| readonly string[] \| undefined` | no | |
|
|
80
|
+
|
|
81
|
+
### ComboboxRootShellOwnProps
|
|
82
|
+
|
|
83
|
+
| Member | Type | Required | Description |
|
|
84
|
+
| --- | --- | --- | --- |
|
|
85
|
+
| `className` | `string` | no | |
|
|
86
|
+
| `defaultInputValue` | `string` | no | |
|
|
87
|
+
| `defaultOpen` | `boolean` | no | |
|
|
88
|
+
| `defaultValue` | `string` | no | |
|
|
89
|
+
| `filterFn` | `ComboboxFilterFn` | no | |
|
|
90
|
+
| `id` | `string` | no | |
|
|
91
|
+
| `items` | `readonly ComboboxItemData[]` | yes | |
|
|
92
|
+
|
|
93
|
+
### ComboboxRootControlledOwnProps
|
|
94
|
+
|
|
95
|
+
| Member | Type | Required | Description |
|
|
96
|
+
| --- | --- | --- | --- |
|
|
97
|
+
| `inputValue` | `string` | no | |
|
|
98
|
+
| `onInputValueChange` | `(value: string) => void` | no | |
|
|
99
|
+
| `onOpenChange` | `PopoverChangeHandler` | no | |
|
|
100
|
+
| `onValueChange` | `(value: string) => void` | no | |
|
|
101
|
+
| `open` | `boolean` | no | |
|
|
102
|
+
| `value` | `string \| readonly string[]` | no | |
|
|
103
|
+
|
|
104
|
+
### ComboboxRootShellProps
|
|
105
|
+
|
|
106
|
+
Extends: `ComboboxRootShellOwnProps`
|
|
107
|
+
|
|
108
|
+
| Member | Type | Required | Description |
|
|
109
|
+
| --- | --- | --- | --- |
|
|
110
|
+
| `children` | `ReactNode` | no | |
|
|
111
|
+
|
|
112
|
+
### ComboboxRootSingleProps
|
|
113
|
+
|
|
114
|
+
Extends: `ComboboxRootShellOwnProps`, `Omit<ComboboxRootControlledOwnProps, "onValueChange" | "value">`
|
|
115
|
+
|
|
116
|
+
| Member | Type | Required | Description |
|
|
117
|
+
| --- | --- | --- | --- |
|
|
118
|
+
| `multiple` | `false` | no | |
|
|
119
|
+
| `defaultValue` | `string` | no | |
|
|
120
|
+
| `onValueChange` | `(value: string) => void` | no | |
|
|
121
|
+
| `value` | `string` | no | |
|
|
122
|
+
| `children` | `ReactNode` | no | |
|
|
123
|
+
|
|
124
|
+
### ComboboxRootMultiProps
|
|
125
|
+
|
|
126
|
+
Extends: `Omit<ComboboxRootShellOwnProps, "defaultValue">`, `Omit<ComboboxRootControlledOwnProps, "onValueChange" | "value">`, `ComboboxMultiValueOptions`
|
|
127
|
+
|
|
128
|
+
| Member | Type | Required | Description |
|
|
129
|
+
| --- | --- | --- | --- |
|
|
130
|
+
| `multiple` | `true` | yes | |
|
|
131
|
+
| `defaultValue` | `readonly string[]` | no | |
|
|
132
|
+
| `onValueChange` | `(value: string[]) => void` | no | |
|
|
133
|
+
| `value` | `readonly string[]` | no | |
|
|
134
|
+
| `children` | `ReactNode` | no | |
|
|
135
|
+
|
|
136
|
+
### ComboboxControlOwnProps
|
|
137
|
+
|
|
138
|
+
| Member | Type | Required | Description |
|
|
139
|
+
| --- | --- | --- | --- |
|
|
140
|
+
| `children` | `ReactNode` | no | |
|
|
141
|
+
| `className` | `string` | no | |
|
|
142
|
+
|
|
143
|
+
### ComboboxTagsOwnProps
|
|
144
|
+
|
|
145
|
+
| Member | Type | Required | Description |
|
|
146
|
+
| --- | --- | --- | --- |
|
|
147
|
+
| `children` | `ReactNode` | no | |
|
|
148
|
+
| `className` | `string` | no | |
|
|
149
|
+
|
|
150
|
+
### ComboboxInputOwnProps
|
|
151
|
+
|
|
152
|
+
| Member | Type | Required | Description |
|
|
153
|
+
| --- | --- | --- | --- |
|
|
154
|
+
| `className` | `string` | no | |
|
|
155
|
+
|
|
156
|
+
### ComboboxTriggerOwnProps
|
|
157
|
+
|
|
158
|
+
| Member | Type | Required | Description |
|
|
159
|
+
| --- | --- | --- | --- |
|
|
160
|
+
| `children` | `ReactNode` | no | |
|
|
161
|
+
| `className` | `string` | no | |
|
|
162
|
+
|
|
163
|
+
### ComboboxContentOwnProps
|
|
164
|
+
|
|
165
|
+
| Member | Type | Required | Description |
|
|
166
|
+
| --- | --- | --- | --- |
|
|
167
|
+
| `align` | `AnchorAlign` | no | |
|
|
168
|
+
| `children` | `(filteredItems: ComboboxItemData[]) => ReactNode` | yes | |
|
|
169
|
+
| `className` | `string` | no | |
|
|
170
|
+
| `side` | `AnchorSide` | no | |
|
|
171
|
+
|
|
172
|
+
### ComboboxItemOwnProps
|
|
173
|
+
|
|
174
|
+
| Member | Type | Required | Description |
|
|
175
|
+
| --- | --- | --- | --- |
|
|
176
|
+
| `className` | `string` | no | |
|
|
177
|
+
| `item` | `ComboboxItemData` | yes | |
|
|
178
|
+
|
|
179
|
+
### ComboboxEmptyOwnProps
|
|
180
|
+
|
|
181
|
+
| Member | Type | Required | Description |
|
|
182
|
+
| --- | --- | --- | --- |
|
|
183
|
+
| `children` | `ReactNode` | no | |
|
|
184
|
+
| `className` | `string` | no | |
|
|
185
|
+
|
|
186
|
+
## Other types
|
|
187
|
+
|
|
188
|
+
- `ComboboxFilterFn`: `(items: readonly ComboboxItemData[], inputValue: string) => ComboboxItemData[]`
|
|
189
|
+
- `ComboboxRootProps`: `ComboboxRootSingleProps | ComboboxRootMultiProps`
|
|
190
|
+
- `ComboboxControlProps<TAs>`: `RenderableProps<TAs, ComboboxControlOwnProps, Record<string, never>, HTMLElement>`
|
|
191
|
+
- `ComboboxTagsProps<TAs>`: `RenderableProps<TAs, ComboboxTagsOwnProps, Record<string, never>, HTMLElement>`
|
|
192
|
+
- `ComboboxInputProps<TAs>`: `RenderableProps<TAs, ComboboxInputOwnProps, { open: boolean }, HTMLInputElement>`
|
|
193
|
+
- `ComboboxTriggerProps<TAs>`: `RenderableProps<TAs, ComboboxTriggerOwnProps, { open: boolean }, HTMLElement>`
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# context-menu
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/context-menu`
|
|
5
|
+
- Tier 2 (Client component — pre-hydration SSR); state source S2; native element `[popover]`
|
|
6
|
+
- Without JavaScript: pre-hydration-only
|
|
7
|
+
- Types file: `dist/components/context-menu.d.ts`
|
|
8
|
+
|
|
9
|
+
## Exports
|
|
10
|
+
|
|
11
|
+
- Runtime: `ContextMenu`, `ContextMenuCheckboxItem`, `ContextMenuContent`, `ContextMenuItem`, `ContextMenuLabel`, `ContextMenuRadioItem`, `ContextMenuRoot`, `ContextMenuSeparator`, `ContextMenuSub`, `ContextMenuSubContent`, `ContextMenuSubTrigger`, `ContextMenuTrigger`
|
|
12
|
+
- Types: `ContextMenuCheckboxItemOwnProps`, `ContextMenuContentOwnProps`, `ContextMenuContentProps`, `ContextMenuItemOwnProps`, `ContextMenuItemProps`, `ContextMenuRadioItemOwnProps`, `ContextMenuRootControlledOwnProps`, `ContextMenuRootShellOwnProps`, `ContextMenuRootShellProps`, `ContextMenuRootProps`, `ContextMenuSubContentOwnProps`, `ContextMenuSubOwnProps`, `ContextMenuSubTriggerOwnProps`, `ContextMenuTriggerOwnProps`, `ContextMenuTriggerProps`, `ContextMenuLabelOwnProps`, `ContextMenuSeparatorOwnProps`
|
|
13
|
+
|
|
14
|
+
## Props and shapes
|
|
15
|
+
|
|
16
|
+
### ContextMenuContextValue
|
|
17
|
+
|
|
18
|
+
Extends: `UseMenuSurfaceReturn`
|
|
19
|
+
|
|
20
|
+
| Member | Type | Required | Description |
|
|
21
|
+
| --- | --- | --- | --- |
|
|
22
|
+
| `openAtPointer` | `(event: MouseEvent<HTMLElement>) => void` | yes | Opens at the pointer's coordinates: positions the virtual anchor, then opens. |
|
|
23
|
+
| `radioValue` | `string \| undefined` | yes | |
|
|
24
|
+
| `setRadioValue` | `(value: string) => void` | yes | |
|
|
25
|
+
|
|
26
|
+
### ContextMenuRootShellOwnProps
|
|
27
|
+
|
|
28
|
+
| Member | Type | Required | Description |
|
|
29
|
+
| --- | --- | --- | --- |
|
|
30
|
+
| `defaultOpen` | `boolean` | no | |
|
|
31
|
+
| `id` | `string` | no | |
|
|
32
|
+
|
|
33
|
+
### ContextMenuRootControlledOwnProps
|
|
34
|
+
|
|
35
|
+
| Member | Type | Required | Description |
|
|
36
|
+
| --- | --- | --- | --- |
|
|
37
|
+
| `onOpenChange` | `PopoverChangeHandler` | no | |
|
|
38
|
+
| `open` | `boolean` | no | |
|
|
39
|
+
|
|
40
|
+
### ContextMenuRootShellProps
|
|
41
|
+
|
|
42
|
+
Extends: `ContextMenuRootShellOwnProps`
|
|
43
|
+
|
|
44
|
+
| Member | Type | Required | Description |
|
|
45
|
+
| --- | --- | --- | --- |
|
|
46
|
+
| `children` | `ReactNode` | no | |
|
|
47
|
+
|
|
48
|
+
### ContextMenuRootProps
|
|
49
|
+
|
|
50
|
+
Extends: `ContextMenuRootShellOwnProps`, `ContextMenuRootControlledOwnProps`
|
|
51
|
+
|
|
52
|
+
| Member | Type | Required | Description |
|
|
53
|
+
| --- | --- | --- | --- |
|
|
54
|
+
| `children` | `ReactNode` | no | |
|
|
55
|
+
|
|
56
|
+
### ContextMenuTriggerOwnProps
|
|
57
|
+
|
|
58
|
+
| Member | Type | Required | Description |
|
|
59
|
+
| --- | --- | --- | --- |
|
|
60
|
+
| `children` | `ReactNode` | no | |
|
|
61
|
+
| `className` | `string` | no | |
|
|
62
|
+
|
|
63
|
+
### ContextMenuContentOwnProps
|
|
64
|
+
|
|
65
|
+
| Member | Type | Required | Description |
|
|
66
|
+
| --- | --- | --- | --- |
|
|
67
|
+
| `children` | `ReactNode` | no | |
|
|
68
|
+
| `className` | `string` | no | |
|
|
69
|
+
|
|
70
|
+
### ContextMenuItemOwnProps
|
|
71
|
+
|
|
72
|
+
| Member | Type | Required | Description |
|
|
73
|
+
| --- | --- | --- | --- |
|
|
74
|
+
| `children` | `ReactNode` | no | |
|
|
75
|
+
| `className` | `string` | no | |
|
|
76
|
+
| `disabled` | `boolean` | no | |
|
|
77
|
+
| `onSelect` | `(event: MenuSelectEvent) => void` | no | |
|
|
78
|
+
| `textValue` | `string` | no | |
|
|
79
|
+
|
|
80
|
+
### ContextMenuCheckboxItemOwnProps
|
|
81
|
+
|
|
82
|
+
| Member | Type | Required | Description |
|
|
83
|
+
| --- | --- | --- | --- |
|
|
84
|
+
| `checked` | `boolean \| "indeterminate"` | no | |
|
|
85
|
+
| `children` | `ReactNode` | no | |
|
|
86
|
+
| `className` | `string` | no | |
|
|
87
|
+
| `disabled` | `boolean` | no | |
|
|
88
|
+
| `onCheckedChange` | `(checked: boolean) => void` | no | |
|
|
89
|
+
| `textValue` | `string` | no | |
|
|
90
|
+
|
|
91
|
+
### ContextMenuRadioItemOwnProps
|
|
92
|
+
|
|
93
|
+
| Member | Type | Required | Description |
|
|
94
|
+
| --- | --- | --- | --- |
|
|
95
|
+
| `children` | `ReactNode` | no | |
|
|
96
|
+
| `className` | `string` | no | |
|
|
97
|
+
| `disabled` | `boolean` | no | |
|
|
98
|
+
| `textValue` | `string` | no | |
|
|
99
|
+
| `value` | `string` | yes | |
|
|
100
|
+
|
|
101
|
+
### ContextMenuSubOwnProps
|
|
102
|
+
|
|
103
|
+
| Member | Type | Required | Description |
|
|
104
|
+
| --- | --- | --- | --- |
|
|
105
|
+
| `children` | `ReactNode` | no | |
|
|
106
|
+
|
|
107
|
+
### ContextMenuSubTriggerOwnProps
|
|
108
|
+
|
|
109
|
+
| Member | Type | Required | Description |
|
|
110
|
+
| --- | --- | --- | --- |
|
|
111
|
+
| `children` | `ReactNode` | no | |
|
|
112
|
+
| `className` | `string` | no | |
|
|
113
|
+
| `disabled` | `boolean` | no | |
|
|
114
|
+
| `textValue` | `string` | no | |
|
|
115
|
+
|
|
116
|
+
### ContextMenuSubContentOwnProps
|
|
117
|
+
|
|
118
|
+
| Member | Type | Required | Description |
|
|
119
|
+
| --- | --- | --- | --- |
|
|
120
|
+
| `children` | `ReactNode` | no | |
|
|
121
|
+
| `className` | `string` | no | |
|
|
122
|
+
|
|
123
|
+
## Other types
|
|
124
|
+
|
|
125
|
+
- `ContextMenuLabelOwnProps`: `DropdownMenuLabelOwnProps`
|
|
126
|
+
- `ContextMenuSeparatorOwnProps`: `DropdownMenuSeparatorOwnProps`
|
|
127
|
+
- `ContextMenuTriggerProps<TAs>`: `RenderableProps<TAs, ContextMenuTriggerOwnProps, { open: boolean }, HTMLElement>`
|
|
128
|
+
- `ContextMenuContentProps<TAs>`: `RenderableProps<TAs, ContextMenuContentOwnProps, { open: boolean }, HTMLElement>`
|
|
129
|
+
- `ContextMenuItemProps<TAs>`: `RenderableProps<TAs, ContextMenuItemOwnProps, { disabled: boolean }, HTMLElement>`
|