@gunkin/uiify 0.0.13-alpha → 0.0.15-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 +12 -0
- package/agents/components.md +79 -0
- package/agents/index.md +173 -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.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 -1
- package/dist/components/button/Button.js.map +1 -1
- package/dist/components/button/types.d.ts +5 -2
- 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/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/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 -0
- 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 -4
- package/dist/components/toggle-group/client/ToggleGroupClient.js.map +1 -1
- package/dist/components/toggle-group/types.d.ts +3 -2
- 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 -1
- package/dist/components/toolbar/ToolbarShell.js.map +1 -1
- package/dist/components/toolbar/types.d.ts +2 -0
- 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 +3 -2
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# drawer
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/drawer`
|
|
5
|
+
- Tier 0 (RSC — zero client JavaScript); state source S1; native element `dialog + command=show-modal`
|
|
6
|
+
- Without JavaScript: full
|
|
7
|
+
- Types file: `dist/components/drawer.d.ts`
|
|
8
|
+
- Note: DrawerPanel native shell + compound Drawer.* client API; snap-point drag on client entry.
|
|
9
|
+
|
|
10
|
+
## Exports
|
|
11
|
+
|
|
12
|
+
- Runtime: `Drawer`, `DrawerClose`, `DrawerContent`, `DrawerDescription`, `DrawerHandle`, `DrawerRoot`, `DrawerTitle`, `DrawerTrigger`, `DrawerPanel`, `DrawerNativeTrigger`, `DrawerNativeClose`, `DrawerNativeContent`
|
|
13
|
+
- Types: `DrawerCloseOwnProps`, `DrawerCloseProps`, `DrawerContentOwnProps`, `DrawerContentProps`, `DrawerDescriptionOwnProps`, `DrawerHandleOwnProps`, `DrawerRootOwnProps`, `DrawerRootProps`, `DrawerTitleOwnProps`, `DrawerTriggerOwnProps`, `DrawerTriggerProps`, `DrawerProps`, `DrawerSide`, `DrawerAppearanceProps`, `DrawerNativeContentProps`, `DrawerNativeInvokerProps`
|
|
14
|
+
|
|
15
|
+
## Values
|
|
16
|
+
|
|
17
|
+
- `DrawerSide`: `"top" | "right" | "bottom" | "left"`
|
|
18
|
+
|
|
19
|
+
## Props and shapes
|
|
20
|
+
|
|
21
|
+
### DrawerAppearanceProps
|
|
22
|
+
|
|
23
|
+
| Member | Type | Required | Description |
|
|
24
|
+
| --- | --- | --- | --- |
|
|
25
|
+
| `size` | `"sm" \| "md" \| "lg" \| "full"` | no | |
|
|
26
|
+
| `dismiss` | `"any" \| "closerequest" \| "none"` | no | |
|
|
27
|
+
| `backdrop` | `"opaque" \| "transparent"` | no | |
|
|
28
|
+
|
|
29
|
+
### DrawerProps
|
|
30
|
+
|
|
31
|
+
Extends: `DrawerAppearanceProps`
|
|
32
|
+
|
|
33
|
+
| Member | Type | Required | Description |
|
|
34
|
+
| --- | --- | --- | --- |
|
|
35
|
+
| `id` | `string` | yes | |
|
|
36
|
+
| `trigger` | `ReactNode` | yes | |
|
|
37
|
+
| `title` | `ReactNode` | yes | |
|
|
38
|
+
| `description` | `ReactNode` | no | |
|
|
39
|
+
| `children` | `ReactNode` | no | |
|
|
40
|
+
| `closeLabel` | `string` | no | |
|
|
41
|
+
| `footer` | `ReactNode` | no | |
|
|
42
|
+
| `side` | `DrawerSide` | no | |
|
|
43
|
+
| `className` | `string` | no | |
|
|
44
|
+
|
|
45
|
+
### DrawerNativeContentProps
|
|
46
|
+
|
|
47
|
+
Extends: `Omit<ComponentPropsWithRef<"dialog">, "open" | "popover" | "closedby">`, `DrawerAppearanceProps`
|
|
48
|
+
|
|
49
|
+
| Member | Type | Required | Description |
|
|
50
|
+
| --- | --- | --- | --- |
|
|
51
|
+
| `id` | `string` | yes | |
|
|
52
|
+
| `side` | `DrawerSide` | no | |
|
|
53
|
+
|
|
54
|
+
### DrawerNativeInvokerProps
|
|
55
|
+
|
|
56
|
+
Extends: `Omit<ComponentPropsWithRef<"button">, "command" | "commandFor">`
|
|
57
|
+
|
|
58
|
+
| Member | Type | Required | Description |
|
|
59
|
+
| --- | --- | --- | --- |
|
|
60
|
+
| `target` | `string` | yes | |
|
|
61
|
+
|
|
62
|
+
### DrawerStoreOptions
|
|
63
|
+
|
|
64
|
+
| Member | Type | Required | Description |
|
|
65
|
+
| --- | --- | --- | --- |
|
|
66
|
+
| `activeSnapPoint` | `number` | no | |
|
|
67
|
+
| `defaultActiveSnapPoint` | `number` | no | |
|
|
68
|
+
| `dismissible` | `boolean` | no | |
|
|
69
|
+
| `onDismiss` | `() => void` | no | |
|
|
70
|
+
| `onSnapChange` | `(snap: number) => void` | no | |
|
|
71
|
+
| `side` | `DrawerSide` | yes | |
|
|
72
|
+
| `snapPoints` | `readonly number[]` | no | |
|
|
73
|
+
|
|
74
|
+
### DrawerStore
|
|
75
|
+
|
|
76
|
+
| Member | Type | Required | Description |
|
|
77
|
+
| --- | --- | --- | --- |
|
|
78
|
+
| `endDrag` | `() => void` | yes | |
|
|
79
|
+
| `getActiveSnapPoint` | `() => number` | yes | |
|
|
80
|
+
| `getDragOffset` | `() => number` | yes | |
|
|
81
|
+
| `getTransform` | `() => string` | yes | |
|
|
82
|
+
| `isDragging` | `() => boolean` | yes | |
|
|
83
|
+
| `moveDrag` | `(clientCoord: number) => void` | yes | |
|
|
84
|
+
| `setSide` | `(side: DrawerSide) => void` | yes | |
|
|
85
|
+
| `setContainerSize` | `(size: number) => void` | yes | |
|
|
86
|
+
| `startDrag` | `(clientCoord: number) => void` | yes | |
|
|
87
|
+
| `subscribe` | `(listener: () => void) => () => void` | yes | |
|
|
88
|
+
| `syncActiveSnapPoint` | `(snap: number) => void` | yes | |
|
|
89
|
+
|
|
90
|
+
### DrawerContextValue
|
|
91
|
+
|
|
92
|
+
| Member | Type | Required | Description |
|
|
93
|
+
| --- | --- | --- | --- |
|
|
94
|
+
| `close` | `(returnValue?: string) => void` | yes | |
|
|
95
|
+
| `contentId` | `string` | yes | |
|
|
96
|
+
| `descriptionId` | `string \| undefined` | yes | |
|
|
97
|
+
| `dialogProps` | `UseDialogReturn["dialogProps"]` | yes | |
|
|
98
|
+
| `dialogRef` | `UseDialogReturn["dialogRef"]` | yes | |
|
|
99
|
+
| `dismissible` | `boolean` | yes | |
|
|
100
|
+
| `closeOnOverlayClick` | `boolean` | yes | |
|
|
101
|
+
| `labelId` | `string \| undefined` | yes | |
|
|
102
|
+
| `modal` | `boolean` | yes | |
|
|
103
|
+
| `open` | `boolean` | yes | |
|
|
104
|
+
| `openDialog` | `() => void` | yes | |
|
|
105
|
+
| `setDescriptionId` | `(id: string \| undefined) => void` | yes | |
|
|
106
|
+
| `setLabelId` | `(id: string \| undefined) => void` | yes | |
|
|
107
|
+
| `side` | `DrawerSide` | yes | |
|
|
108
|
+
| `snapEnabled` | `boolean` | yes | |
|
|
109
|
+
| `store` | `DrawerStore` | yes | |
|
|
110
|
+
| `triggerRef` | `RefObject<HTMLButtonElement \| null>` | yes | |
|
|
111
|
+
|
|
112
|
+
### DrawerRootOwnProps
|
|
113
|
+
|
|
114
|
+
| Member | Type | Required | Description |
|
|
115
|
+
| --- | --- | --- | --- |
|
|
116
|
+
| `activeSnapPoint` | `number` | no | |
|
|
117
|
+
| `closeOnOverlayClick` | `boolean` | no | |
|
|
118
|
+
| `defaultActiveSnapPoint` | `number` | no | |
|
|
119
|
+
| `defaultOpen` | `boolean` | no | |
|
|
120
|
+
| `dismissible` | `boolean` | no | |
|
|
121
|
+
| `modal` | `boolean` | no | |
|
|
122
|
+
| `onOpenChange` | `DialogChangeHandler` | no | |
|
|
123
|
+
| `onSnapChange` | `(snap: number) => void` | no | |
|
|
124
|
+
| `open` | `boolean` | no | |
|
|
125
|
+
| `side` | `DrawerSide` | no | |
|
|
126
|
+
| `snapPoints` | `readonly number[]` | no | |
|
|
127
|
+
|
|
128
|
+
### DrawerRootProps
|
|
129
|
+
|
|
130
|
+
Extends: `DrawerRootOwnProps`
|
|
131
|
+
|
|
132
|
+
| Member | Type | Required | Description |
|
|
133
|
+
| --- | --- | --- | --- |
|
|
134
|
+
| `children` | `ReactNode` | no | |
|
|
135
|
+
|
|
136
|
+
### DrawerTriggerOwnProps
|
|
137
|
+
|
|
138
|
+
| Member | Type | Required | Description |
|
|
139
|
+
| --- | --- | --- | --- |
|
|
140
|
+
| `children` | `ReactNode` | no | |
|
|
141
|
+
| `className` | `string` | no | |
|
|
142
|
+
|
|
143
|
+
### DrawerTriggerProps
|
|
144
|
+
|
|
145
|
+
Extends: `DrawerTriggerOwnProps`, `Omit<ComponentPropsWithRef<"button">, "type" | keyof DrawerTriggerOwnProps>`
|
|
146
|
+
|
|
147
|
+
| Member | Type | Required | Description |
|
|
148
|
+
| --- | --- | --- | --- |
|
|
149
|
+
| `onClick` | `(event: MouseEvent<HTMLButtonElement>) => void` | no | |
|
|
150
|
+
| `ref` | `Ref<HTMLButtonElement>` | no | |
|
|
151
|
+
|
|
152
|
+
### DrawerContentOwnProps
|
|
153
|
+
|
|
154
|
+
Extends: `DrawerAppearanceProps`
|
|
155
|
+
|
|
156
|
+
| Member | Type | Required | Description |
|
|
157
|
+
| --- | --- | --- | --- |
|
|
158
|
+
| `children` | `ReactNode` | no | |
|
|
159
|
+
| `className` | `string` | no | |
|
|
160
|
+
| `style` | `CSSProperties` | no | |
|
|
161
|
+
|
|
162
|
+
### DrawerContentProps
|
|
163
|
+
|
|
164
|
+
Extends: `DrawerContentOwnProps`, `Omit<ComponentPropsWithRef<"dialog">, "id" | "open" | "closedby" | keyof DrawerContentOwnProps>`
|
|
165
|
+
|
|
166
|
+
| Member | Type | Required | Description |
|
|
167
|
+
| --- | --- | --- | --- |
|
|
168
|
+
| `onCancel` | `DrawerContextValue["dialogProps"]["onCancel"]` | no | |
|
|
169
|
+
| `onClose` | `DrawerContextValue["dialogProps"]["onClose"]` | no | |
|
|
170
|
+
| `ref` | `Ref<HTMLDialogElement>` | no | |
|
|
171
|
+
|
|
172
|
+
### DrawerTitleOwnProps
|
|
173
|
+
|
|
174
|
+
Extends: `Omit<ComponentPropsWithRef<"h2">, "id">`
|
|
175
|
+
|
|
176
|
+
| Member | Type | Required | Description |
|
|
177
|
+
| --- | --- | --- | --- |
|
|
178
|
+
| `children` | `ReactNode` | no | |
|
|
179
|
+
| `className` | `string` | no | |
|
|
180
|
+
|
|
181
|
+
### DrawerDescriptionOwnProps
|
|
182
|
+
|
|
183
|
+
Extends: `Omit<ComponentPropsWithRef<"p">, "id">`
|
|
184
|
+
|
|
185
|
+
| Member | Type | Required | Description |
|
|
186
|
+
| --- | --- | --- | --- |
|
|
187
|
+
| `children` | `ReactNode` | no | |
|
|
188
|
+
| `className` | `string` | no | |
|
|
189
|
+
|
|
190
|
+
### DrawerCloseOwnProps
|
|
191
|
+
|
|
192
|
+
| Member | Type | Required | Description |
|
|
193
|
+
| --- | --- | --- | --- |
|
|
194
|
+
| `children` | `ReactNode` | no | |
|
|
195
|
+
| `className` | `string` | no | |
|
|
196
|
+
|
|
197
|
+
### DrawerCloseProps
|
|
198
|
+
|
|
199
|
+
Extends: `DrawerCloseOwnProps`, `Omit<ComponentPropsWithRef<"button">, "type" | keyof DrawerCloseOwnProps>`
|
|
200
|
+
|
|
201
|
+
| Member | Type | Required | Description |
|
|
202
|
+
| --- | --- | --- | --- |
|
|
203
|
+
| `onClick` | `(event: MouseEvent<HTMLButtonElement>) => void` | no | |
|
|
204
|
+
|
|
205
|
+
### DrawerHandleOwnProps
|
|
206
|
+
|
|
207
|
+
Extends: `ComponentPropsWithRef<"div">`
|
|
208
|
+
|
|
209
|
+
| Member | Type | Required | Description |
|
|
210
|
+
| --- | --- | --- | --- |
|
|
211
|
+
| `className` | `string` | no | |
|
|
212
|
+
| `onPointerCancel` | `(event: PointerEvent<HTMLDivElement>) => void` | no | |
|
|
213
|
+
| `onPointerDown` | `(event: PointerEvent<HTMLDivElement>) => void` | no | |
|
|
214
|
+
| `onPointerMove` | `(event: PointerEvent<HTMLDivElement>) => void` | no | |
|
|
215
|
+
| `onPointerUp` | `(event: PointerEvent<HTMLDivElement>) => void` | no | |
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# dropdown-menu
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/dropdown-menu`
|
|
5
|
+
- Tier 2 (Client component — pre-hydration SSR); state source S2; native element `[popover]+commandfor`
|
|
6
|
+
- Without JavaScript: pre-hydration-only
|
|
7
|
+
- Types file: `dist/components/dropdown-menu.d.ts`
|
|
8
|
+
|
|
9
|
+
## Exports
|
|
10
|
+
|
|
11
|
+
- Runtime: `DropdownMenu`, `DropdownMenuCheckboxItem`, `DropdownMenuContent`, `DropdownMenuGroup`, `DropdownMenuItem`, `DropdownMenuItemDescription`, `DropdownMenuItemIcon`, `DropdownMenuItemIndicator`, `DropdownMenuItemText`, `DropdownMenuLabel`, `DropdownMenuRadioGroup`, `DropdownMenuRadioItem`, `DropdownMenuRoot`, `DropdownMenuSeparator`, `DropdownMenuShortcut`, `DropdownMenuSub`, `DropdownMenuSubContent`, `DropdownMenuSubTrigger`, `DropdownMenuTrigger`, `DropdownMenuBar`
|
|
12
|
+
- Types: `MenuSelectEvent`, `DropdownMenuBarOwnProps`, `DropdownMenuBarProps`, `DropdownMenuContentOwnProps`, `DropdownMenuContentProps`, `DropdownMenuCheckedState`, `DropdownMenuCheckboxItemOwnProps`, `DropdownMenuCheckboxItemProps`, `DropdownMenuGroupOwnProps`, `DropdownMenuItemDescriptionProps`, `DropdownMenuItemIconProps`, `DropdownMenuItemIndicatorProps`, `DropdownMenuItemOwnProps`, `DropdownMenuItemProps`, `DropdownMenuItemTextProps`, `DropdownMenuLabelOwnProps`, `DropdownMenuOpenChangeDetails`, `DropdownMenuOpenChangeReason`, `DropdownMenuPartOwnProps`, `DropdownMenuPartProps`, `DropdownMenuRadioGroupOwnProps`, `DropdownMenuRadioGroupProps`, `DropdownMenuRadioItemOwnProps`, `DropdownMenuRadioItemProps`, `DropdownMenuRootControlledOwnProps`, `DropdownMenuRootShellOwnProps`, `DropdownMenuRootShellProps`, `DropdownMenuRootOwnProps`, `DropdownMenuRootProps`, `DropdownMenuSeparatorOwnProps`, `DropdownMenuShortcutProps`, `DropdownMenuSubContentProps`, `DropdownMenuSubOwnProps`, `DropdownMenuSubProps`, `DropdownMenuSubTriggerOwnProps`, `DropdownMenuSubTriggerProps`, `DropdownMenuTriggerOwnProps`, `DropdownMenuTriggerProps`
|
|
13
|
+
|
|
14
|
+
## Values
|
|
15
|
+
|
|
16
|
+
- `DropdownMenuOpenChangeReason`: `"trigger-press" | "item-select" | "escape" | "focus-out" | "outside-press" | "programmatic"`
|
|
17
|
+
|
|
18
|
+
## Props and shapes
|
|
19
|
+
|
|
20
|
+
### DropdownMenuOpenChangeDetails
|
|
21
|
+
|
|
22
|
+
| Member | Type | Required | Description |
|
|
23
|
+
| --- | --- | --- | --- |
|
|
24
|
+
| `event` | `Event \| null` | yes | |
|
|
25
|
+
| `reason` | `DropdownMenuOpenChangeReason` | yes | |
|
|
26
|
+
|
|
27
|
+
### DropdownMenuContextValue
|
|
28
|
+
|
|
29
|
+
Extends: `UseMenuSurfaceReturn`
|
|
30
|
+
|
|
31
|
+
| Member | Type | Required | Description |
|
|
32
|
+
| --- | --- | --- | --- |
|
|
33
|
+
| `cancelHoverClose` | `() => void` | yes | |
|
|
34
|
+
| `dir` | `Direction` | yes | |
|
|
35
|
+
| `disabled` | `boolean` | yes | |
|
|
36
|
+
| `hoverEnabledRef` | `RefObject<boolean>` | yes | |
|
|
37
|
+
| `loop` | `boolean` | yes | |
|
|
38
|
+
| `scheduleHoverClose` | `() => void` | yes | |
|
|
39
|
+
|
|
40
|
+
### DropdownMenuBarOwnProps
|
|
41
|
+
|
|
42
|
+
| Member | Type | Required | Description |
|
|
43
|
+
| --- | --- | --- | --- |
|
|
44
|
+
| `children` | `ReactNode` | no | |
|
|
45
|
+
| `className` | `string` | no | |
|
|
46
|
+
| `dir` | `Direction` | no | |
|
|
47
|
+
| `loop` | `boolean` | no | |
|
|
48
|
+
|
|
49
|
+
### DropdownMenuRootOwnProps
|
|
50
|
+
|
|
51
|
+
| Member | Type | Required | Description |
|
|
52
|
+
| --- | --- | --- | --- |
|
|
53
|
+
| `className` | `string` | no | |
|
|
54
|
+
| `children` | `ReactNode` | no | |
|
|
55
|
+
| `defaultOpen` | `boolean` | no | |
|
|
56
|
+
| `dir` | `Direction` | no | |
|
|
57
|
+
| `disabled` | `boolean` | no | |
|
|
58
|
+
| `id` | `string` | no | |
|
|
59
|
+
| `loop` | `boolean` | no | |
|
|
60
|
+
| `onOpenChange` | `(open: boolean, details: DropdownMenuOpenChangeDetails) => void` | no | |
|
|
61
|
+
| `open` | `boolean` | no | |
|
|
62
|
+
|
|
63
|
+
### DropdownMenuTriggerOwnProps
|
|
64
|
+
|
|
65
|
+
| Member | Type | Required | Description |
|
|
66
|
+
| --- | --- | --- | --- |
|
|
67
|
+
| `children` | `ReactNode` | no | |
|
|
68
|
+
| `className` | `string` | no | |
|
|
69
|
+
| `openOnHover` | `boolean` | no | |
|
|
70
|
+
|
|
71
|
+
### DropdownMenuContentOwnProps
|
|
72
|
+
|
|
73
|
+
| Member | Type | Required | Description |
|
|
74
|
+
| --- | --- | --- | --- |
|
|
75
|
+
| `align` | `AnchorAlign` | no | |
|
|
76
|
+
| `children` | `ReactNode` | no | |
|
|
77
|
+
| `className` | `string` | no | |
|
|
78
|
+
| `side` | `AnchorSide` | no | |
|
|
79
|
+
|
|
80
|
+
### DropdownMenuItemOwnProps
|
|
81
|
+
|
|
82
|
+
| Member | Type | Required | Description |
|
|
83
|
+
| --- | --- | --- | --- |
|
|
84
|
+
| `children` | `ReactNode` | no | |
|
|
85
|
+
| `className` | `string` | no | |
|
|
86
|
+
| `closeOnSelect` | `boolean` | no | |
|
|
87
|
+
| `disabled` | `boolean` | no | |
|
|
88
|
+
| `onSelect` | `(event: MenuSelectEvent) => void` | no | |
|
|
89
|
+
| `textValue` | `string` | no | |
|
|
90
|
+
|
|
91
|
+
### DropdownMenuCheckboxItemOwnProps
|
|
92
|
+
|
|
93
|
+
Extends: `DropdownMenuItemOwnProps`
|
|
94
|
+
|
|
95
|
+
| Member | Type | Required | Description |
|
|
96
|
+
| --- | --- | --- | --- |
|
|
97
|
+
| `checked` | `DropdownMenuCheckedState` | no | |
|
|
98
|
+
| `defaultChecked` | `DropdownMenuCheckedState` | no | |
|
|
99
|
+
| `onCheckedChange` | `(checked: boolean) => void` | no | |
|
|
100
|
+
|
|
101
|
+
### DropdownMenuRadioGroupOwnProps
|
|
102
|
+
|
|
103
|
+
| Member | Type | Required | Description |
|
|
104
|
+
| --- | --- | --- | --- |
|
|
105
|
+
| `children` | `ReactNode` | no | |
|
|
106
|
+
| `className` | `string` | no | |
|
|
107
|
+
| `defaultValue` | `string` | no | |
|
|
108
|
+
| `onValueChange` | `(value: string) => void` | no | |
|
|
109
|
+
| `value` | `string` | no | |
|
|
110
|
+
|
|
111
|
+
### DropdownMenuRadioItemOwnProps
|
|
112
|
+
|
|
113
|
+
Extends: `DropdownMenuItemOwnProps`
|
|
114
|
+
|
|
115
|
+
| Member | Type | Required | Description |
|
|
116
|
+
| --- | --- | --- | --- |
|
|
117
|
+
| `value` | `string` | yes | |
|
|
118
|
+
|
|
119
|
+
### DropdownMenuSubOwnProps
|
|
120
|
+
|
|
121
|
+
| Member | Type | Required | Description |
|
|
122
|
+
| --- | --- | --- | --- |
|
|
123
|
+
| `children` | `ReactNode` | no | |
|
|
124
|
+
| `defaultOpen` | `boolean` | no | |
|
|
125
|
+
| `onOpenChange` | `(open: boolean, details: DropdownMenuOpenChangeDetails) => void` | no | |
|
|
126
|
+
| `open` | `boolean` | no | |
|
|
127
|
+
|
|
128
|
+
### DropdownMenuSubTriggerOwnProps
|
|
129
|
+
|
|
130
|
+
Extends: `DropdownMenuItemOwnProps`
|
|
131
|
+
|
|
132
|
+
No own members.
|
|
133
|
+
|
|
134
|
+
### DropdownMenuPartOwnProps
|
|
135
|
+
|
|
136
|
+
| Member | Type | Required | Description |
|
|
137
|
+
| --- | --- | --- | --- |
|
|
138
|
+
| `children` | `ReactNode` | no | |
|
|
139
|
+
| `className` | `string` | no | |
|
|
140
|
+
|
|
141
|
+
### DropdownMenuSubContextValue
|
|
142
|
+
|
|
143
|
+
| Member | Type | Required | Description |
|
|
144
|
+
| --- | --- | --- | --- |
|
|
145
|
+
| `contentRef` | `RefObject<HTMLElement \| null>` | yes | |
|
|
146
|
+
| `open` | `boolean` | yes | |
|
|
147
|
+
| `setOpen` | `(open: boolean, reason: DropdownMenuOpenChangeReason, event?: Event \| null) => void` | yes | |
|
|
148
|
+
| `triggerRef` | `RefObject<HTMLElement \| null>` | yes | |
|
|
149
|
+
|
|
150
|
+
## Other types
|
|
151
|
+
|
|
152
|
+
- `DropdownMenuCheckedState`: `boolean | "indeterminate"`
|
|
153
|
+
- `DropdownMenuBarProps`: `DropdownMenuBarOwnProps`
|
|
154
|
+
- `DropdownMenuRootProps`: `DropdownMenuRootOwnProps`
|
|
155
|
+
- `DropdownMenuRootShellOwnProps`: `DropdownMenuRootOwnProps`
|
|
156
|
+
- `DropdownMenuRootControlledOwnProps`: `Pick<DropdownMenuRootOwnProps, "onOpenChange" | "open">`
|
|
157
|
+
- `DropdownMenuRootShellProps`: `DropdownMenuRootOwnProps`
|
|
158
|
+
- `DropdownMenuTriggerProps<TAs>`: `RenderableProps<TAs, DropdownMenuTriggerOwnProps, { open: boolean }, HTMLElement>`
|
|
159
|
+
- `DropdownMenuContentProps<TAs>`: `RenderableProps<TAs, DropdownMenuContentOwnProps, { open: boolean }, HTMLElement>`
|
|
160
|
+
- `DropdownMenuItemProps<TAs>`: `RenderableProps<TAs, DropdownMenuItemOwnProps, { disabled: boolean }, HTMLElement>`
|
|
161
|
+
- `DropdownMenuCheckboxItemProps<TAs>`: `RenderableProps<TAs, DropdownMenuCheckboxItemOwnProps, { checked: DropdownMenuCheckedState; disabled: boolean }, HTMLElement>`
|
|
162
|
+
- `DropdownMenuRadioGroupProps<TAs>`: `RenderableProps<TAs, DropdownMenuRadioGroupOwnProps, { value: string | undefined }, HTMLElement>`
|
|
163
|
+
- `DropdownMenuRadioItemProps<TAs>`: `RenderableProps<TAs, DropdownMenuRadioItemOwnProps, { checked: boolean; disabled: boolean }, HTMLElement>`
|
|
164
|
+
- `DropdownMenuSubProps`: `DropdownMenuSubOwnProps`
|
|
165
|
+
- `DropdownMenuSubTriggerProps<TAs>`: `RenderableProps<TAs, DropdownMenuSubTriggerOwnProps, { disabled: boolean; open: boolean }, HTMLElement>`
|
|
166
|
+
- `DropdownMenuSubContentProps<TAs>`: `RenderableProps<TAs, DropdownMenuContentOwnProps, { open: boolean }, HTMLElement>`
|
|
167
|
+
- `DropdownMenuPartProps<TAs>`: `RenderableProps<TAs, DropdownMenuPartOwnProps, Record<string, never>, HTMLElement>`
|
|
168
|
+
- `DropdownMenuGroupOwnProps`: `DropdownMenuPartOwnProps`
|
|
169
|
+
- `DropdownMenuLabelOwnProps`: `DropdownMenuPartOwnProps`
|
|
170
|
+
- `DropdownMenuSeparatorOwnProps`: `Omit<DropdownMenuPartOwnProps, "children">`
|
|
171
|
+
- `DropdownMenuGroupProps<TAs>`: `MenuGroupProps<TAs>`
|
|
172
|
+
- `DropdownMenuLabelProps<TAs>`: `MenuLabelProps<TAs>`
|
|
173
|
+
- `DropdownMenuSeparatorProps<TAs>`: `MenuSeparatorProps<TAs>`
|
|
174
|
+
- `DropdownMenuItemIconProps<TAs>`: `DropdownMenuPartProps<TAs>`
|
|
175
|
+
- `DropdownMenuItemTextProps<TAs>`: `DropdownMenuPartProps<TAs>`
|
|
176
|
+
- `DropdownMenuItemDescriptionProps<TAs>`: `DropdownMenuPartProps<TAs>`
|
|
177
|
+
- `DropdownMenuShortcutProps<TAs>`: `DropdownMenuPartProps<TAs>`
|
|
178
|
+
- `DropdownMenuItemIndicatorProps<TAs>`: `DropdownMenuPartProps<TAs>`
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# field
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/field`
|
|
5
|
+
- Tier 0 (RSC — zero client JavaScript); state source none; native element `div:has(input)`
|
|
6
|
+
- Without JavaScript: full
|
|
7
|
+
- Types file: `dist/components/field.d.ts`
|
|
8
|
+
- Note: :user-invalid + :has() reveals the error message
|
|
9
|
+
|
|
10
|
+
## Exports
|
|
11
|
+
|
|
12
|
+
- Runtime: `Field`, `FieldControl`, `FieldDescription`, `FieldError`, `FieldLabel`, `FieldRoot`
|
|
13
|
+
- Types: `FieldControlProps`, `FieldDescriptionProps`, `FieldErrorProps`, `FieldLabelProps`, `FieldRootOwnProps`, `FieldRootProps`
|
|
14
|
+
|
|
15
|
+
## Props and shapes
|
|
16
|
+
|
|
17
|
+
### FieldRootOwnProps
|
|
18
|
+
|
|
19
|
+
| Member | Type | Required | Description |
|
|
20
|
+
| --- | --- | --- | --- |
|
|
21
|
+
| `id` | `string` | yes | Stable id for deterministic label/control/error wiring. Required. |
|
|
22
|
+
| `invalid` | `boolean` | no | |
|
|
23
|
+
| `required` | `boolean` | no | |
|
|
24
|
+
| `disabled` | `boolean` | no | |
|
|
25
|
+
| `name` | `string` | no | |
|
|
26
|
+
|
|
27
|
+
### FieldPartOwnProps
|
|
28
|
+
|
|
29
|
+
Every part connects to Field.Root by this one explicit prop — the same `id` passed to Root — instead of props injected via child traversal.
|
|
30
|
+
|
|
31
|
+
| Member | Type | Required | Description |
|
|
32
|
+
| --- | --- | --- | --- |
|
|
33
|
+
| `fieldId` | `string` | yes | |
|
|
34
|
+
|
|
35
|
+
### FieldLabelOwnProps
|
|
36
|
+
|
|
37
|
+
Extends: `FieldPartOwnProps`
|
|
38
|
+
|
|
39
|
+
| Member | Type | Required | Description |
|
|
40
|
+
| --- | --- | --- | --- |
|
|
41
|
+
| `disabled` | `boolean` | no | |
|
|
42
|
+
| `required` | `boolean` | no | |
|
|
43
|
+
|
|
44
|
+
### FieldControlOwnProps
|
|
45
|
+
|
|
46
|
+
Extends: `FieldPartOwnProps`
|
|
47
|
+
|
|
48
|
+
| Member | Type | Required | Description |
|
|
49
|
+
| --- | --- | --- | --- |
|
|
50
|
+
| `disabled` | `boolean` | no | |
|
|
51
|
+
| `invalid` | `boolean` | no | |
|
|
52
|
+
| `required` | `boolean` | no | |
|
|
53
|
+
|
|
54
|
+
### FieldDescriptionOwnProps
|
|
55
|
+
|
|
56
|
+
Extends: `FieldPartOwnProps`
|
|
57
|
+
|
|
58
|
+
| Member | Type | Required | Description |
|
|
59
|
+
| --- | --- | --- | --- |
|
|
60
|
+
| `disabled` | `boolean` | no | |
|
|
61
|
+
|
|
62
|
+
### FieldErrorOwnProps
|
|
63
|
+
|
|
64
|
+
Extends: `FieldPartOwnProps`
|
|
65
|
+
|
|
66
|
+
| Member | Type | Required | Description |
|
|
67
|
+
| --- | --- | --- | --- |
|
|
68
|
+
| `invalid` | `boolean` | no | |
|
|
69
|
+
|
|
70
|
+
## Other types
|
|
71
|
+
|
|
72
|
+
- `FieldRootProps<TAs>`: `RenderableProps<TAs, FieldRootOwnProps, FieldRootOwnProps, HTMLElement>`
|
|
73
|
+
- `FieldLabelProps`: `FieldLabelOwnProps & Omit<HTMLAttributes<HTMLLabelElement>, "htmlFor" | keyof FieldLabelOwnProps>`
|
|
74
|
+
- `FieldControlProps<TAs>`: `RenderableProps<TAs, FieldControlOwnProps, { disabled: boolean; invalid: boolean; required: boolean }, HTMLElement>`
|
|
75
|
+
- `FieldDescriptionProps`: `FieldDescriptionOwnProps & Omit<HTMLAttributes<HTMLElement>, keyof FieldDescriptionOwnProps>`
|
|
76
|
+
- `FieldErrorProps`: `FieldErrorOwnProps & Omit<HTMLAttributes<HTMLElement>, keyof FieldErrorOwnProps>`
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# file-upload
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/file-upload`
|
|
5
|
+
- Tier 1 (RSC shell + thin client island); state source S1; native element `input[type=file]`
|
|
6
|
+
- Without JavaScript: degraded-documented
|
|
7
|
+
- Types file: `dist/components/file-upload.d.ts`
|
|
8
|
+
|
|
9
|
+
## Exports
|
|
10
|
+
|
|
11
|
+
- Runtime: `FileUpload`, `FileUploadDropzone`, `FileUploadHiddenInput`, `FileUploadItem`, `FileUploadItemRemove`, `FileUploadList`, `FileUploadRoot`, `FileUploadTrigger`, `validateFiles`
|
|
12
|
+
- Types: `FileUploadDropzoneOwnProps`, `FileUploadDropzoneProps`, `FileUploadHiddenInputOwnProps`, `FileUploadListOwnProps`, `FileUploadItemRemoveOwnProps`, `FileUploadItemOwnProps`, `FileUploadItemProps`, `FileUploadRootOwnProps`, `FileUploadRootProps`, `FileUploadTriggerOwnProps`, `FileUploadTriggerProps`, `FileRejection`, `FileUploadStore`
|
|
13
|
+
|
|
14
|
+
## Props and shapes
|
|
15
|
+
|
|
16
|
+
### FileRejection
|
|
17
|
+
|
|
18
|
+
| Member | Type | Required | Description |
|
|
19
|
+
| --- | --- | --- | --- |
|
|
20
|
+
| `file` | `File` | yes | |
|
|
21
|
+
| `reason` | `"accept" \| "max-size" \| "max-files"` | yes | |
|
|
22
|
+
|
|
23
|
+
### FileUploadStoreOptions
|
|
24
|
+
|
|
25
|
+
| Member | Type | Required | Description |
|
|
26
|
+
| --- | --- | --- | --- |
|
|
27
|
+
| `accept` | `readonly string[]` | no | |
|
|
28
|
+
| `maxFiles` | `number` | no | |
|
|
29
|
+
| `maxSize` | `number` | no | |
|
|
30
|
+
| `minSize` | `number` | no | |
|
|
31
|
+
| `multiple` | `boolean` | no | |
|
|
32
|
+
|
|
33
|
+
### FileUploadStore
|
|
34
|
+
|
|
35
|
+
| Member | Type | Required | Description |
|
|
36
|
+
| --- | --- | --- | --- |
|
|
37
|
+
| `addFiles` | `(next: readonly File[]) => void` | yes | |
|
|
38
|
+
| `clear` | `() => void` | yes | |
|
|
39
|
+
| `getFiles` | `() => File[]` | yes | |
|
|
40
|
+
| `removeAt` | `(index: number) => void` | yes | |
|
|
41
|
+
| `setFiles` | `(next: readonly File[]) => void` | yes | |
|
|
42
|
+
| `subscribe` | `(listener: () => void) => () => void` | yes | |
|
|
43
|
+
|
|
44
|
+
### FileUploadContextValue
|
|
45
|
+
|
|
46
|
+
| Member | Type | Required | Description |
|
|
47
|
+
| --- | --- | --- | --- |
|
|
48
|
+
| `accept` | `readonly string[]` | yes | |
|
|
49
|
+
| `disabled` | `boolean` | yes | |
|
|
50
|
+
| `hiddenInputRef` | `RefObject<HTMLInputElement \| null>` | yes | |
|
|
51
|
+
| `inputId` | `string` | yes | |
|
|
52
|
+
| `multiple` | `boolean` | yes | |
|
|
53
|
+
| `openPicker` | `() => void` | yes | |
|
|
54
|
+
| `processFiles` | `(list: FileList \| readonly File[]) => void` | yes | |
|
|
55
|
+
| `removeAt` | `(index: number) => void` | yes | |
|
|
56
|
+
| `reset` | `() => void` | yes | |
|
|
57
|
+
| `files` | `readonly File[]` | yes | |
|
|
58
|
+
|
|
59
|
+
### FileUploadRootOwnProps
|
|
60
|
+
|
|
61
|
+
| Member | Type | Required | Description |
|
|
62
|
+
| --- | --- | --- | --- |
|
|
63
|
+
| `className` | `string` | no | |
|
|
64
|
+
| `accept` | `readonly string[]` | no | |
|
|
65
|
+
| `defaultValue` | `readonly File[]` | no | |
|
|
66
|
+
| `disabled` | `boolean` | no | |
|
|
67
|
+
| `maxFiles` | `number` | no | |
|
|
68
|
+
| `maxSize` | `number` | no | |
|
|
69
|
+
| `minSize` | `number` | no | |
|
|
70
|
+
| `multiple` | `boolean` | no | |
|
|
71
|
+
| `onValueChange` | `(files: File[]) => void` | no | |
|
|
72
|
+
| `onReject` | `(rejections: FileRejection[]) => void` | no | |
|
|
73
|
+
| `value` | `readonly File[]` | no | |
|
|
74
|
+
|
|
75
|
+
### FileUploadRootProps
|
|
76
|
+
|
|
77
|
+
Extends: `FileUploadRootOwnProps`, `Omit<ComponentPropsWithRef<"div">, keyof FileUploadRootOwnProps | "defaultValue">`
|
|
78
|
+
|
|
79
|
+
| Member | Type | Required | Description |
|
|
80
|
+
| --- | --- | --- | --- |
|
|
81
|
+
| `children` | `ReactNode` | no | |
|
|
82
|
+
|
|
83
|
+
### FileUploadHiddenInputOwnProps
|
|
84
|
+
|
|
85
|
+
Extends: `Omit<ComponentPropsWithRef<"input">, "type" | "value" | "defaultValue" | "accept" | "multiple" | "disabled">`
|
|
86
|
+
|
|
87
|
+
No own members.
|
|
88
|
+
|
|
89
|
+
### FileUploadTriggerOwnProps
|
|
90
|
+
|
|
91
|
+
| Member | Type | Required | Description |
|
|
92
|
+
| --- | --- | --- | --- |
|
|
93
|
+
| `children` | `ReactNode` | no | |
|
|
94
|
+
| `className` | `string` | no | |
|
|
95
|
+
|
|
96
|
+
### FileUploadDropzoneOwnProps
|
|
97
|
+
|
|
98
|
+
| Member | Type | Required | Description |
|
|
99
|
+
| --- | --- | --- | --- |
|
|
100
|
+
| `children` | `ReactNode` | no | |
|
|
101
|
+
| `className` | `string` | no | |
|
|
102
|
+
|
|
103
|
+
### FileUploadListOwnProps
|
|
104
|
+
|
|
105
|
+
Extends: `Omit<ComponentPropsWithRef<"ul">, "children">`
|
|
106
|
+
|
|
107
|
+
| Member | Type | Required | Description |
|
|
108
|
+
| --- | --- | --- | --- |
|
|
109
|
+
| `children` | `ReactNode \| ((files: readonly File[]) => ReactNode)` | no | |
|
|
110
|
+
|
|
111
|
+
### FileUploadItemOwnProps
|
|
112
|
+
|
|
113
|
+
| Member | Type | Required | Description |
|
|
114
|
+
| --- | --- | --- | --- |
|
|
115
|
+
| `children` | `ReactNode` | no | |
|
|
116
|
+
| `className` | `string` | no | |
|
|
117
|
+
| `index` | `number` | yes | |
|
|
118
|
+
|
|
119
|
+
### FileUploadItemRemoveOwnProps
|
|
120
|
+
|
|
121
|
+
Extends: `ComponentPropsWithRef<"button">`
|
|
122
|
+
|
|
123
|
+
| Member | Type | Required | Description |
|
|
124
|
+
| --- | --- | --- | --- |
|
|
125
|
+
| `index` | `number` | yes | |
|
|
126
|
+
|
|
127
|
+
## Other types
|
|
128
|
+
|
|
129
|
+
- `FileUploadTriggerProps<TAs>`: `RenderableProps<TAs, FileUploadTriggerOwnProps, { disabled: boolean }, HTMLElement>`
|
|
130
|
+
- `FileUploadDropzoneProps<TAs>`: `RenderableProps<TAs, FileUploadDropzoneOwnProps, { disabled: boolean }, HTMLElement>`
|
|
131
|
+
- `FileUploadItemProps<TAs>`: `RenderableProps<TAs, FileUploadItemOwnProps, { index: number }, HTMLElement>`
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# form
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/form`
|
|
5
|
+
- Tier 0 (RSC — zero client JavaScript); state source none; native element `form`
|
|
6
|
+
- Without JavaScript: full
|
|
7
|
+
- Types file: `dist/components/form.d.ts`
|
|
8
|
+
|
|
9
|
+
## Exports
|
|
10
|
+
|
|
11
|
+
- Runtime: `Form`
|
|
12
|
+
- Types: `FormOwnProps`, `FormProps`, `ValidationBehavior`
|
|
13
|
+
|
|
14
|
+
## Values
|
|
15
|
+
|
|
16
|
+
- `ValidationBehavior`: `"native" | "aria"`
|
|
17
|
+
|
|
18
|
+
## Props and shapes
|
|
19
|
+
|
|
20
|
+
### FormOwnProps
|
|
21
|
+
|
|
22
|
+
| Member | Type | Required | Description |
|
|
23
|
+
| --- | --- | --- | --- |
|
|
24
|
+
| `validationBehavior` | `ValidationBehavior` | no | |
|
|
25
|
+
|
|
26
|
+
## Other types
|
|
27
|
+
|
|
28
|
+
- `FormProps<TAs>`: `RenderableProps<TAs, FormOwnProps, FormOwnProps, HTMLFormElement>`
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
<!-- Generated from the package source. Do not edit by hand. -->
|
|
2
|
+
# header
|
|
3
|
+
|
|
4
|
+
- Import: `@gunkin/uiify/components/header`
|
|
5
|
+
- Tier 0 (RSC — zero client JavaScript); state source S1; native element `header`
|
|
6
|
+
- Without JavaScript: full
|
|
7
|
+
- Types file: `dist/components/header.d.ts`
|
|
8
|
+
- Note: Semantic header root; compose native navigation with Modal. Full functionality without JavaScript; optional header/client adds scroll hide/reveal.
|
|
9
|
+
|
|
10
|
+
## Exports
|
|
11
|
+
|
|
12
|
+
- Runtime: `Header`, `HeaderRoot`
|
|
13
|
+
- Types: `HeaderClientProps`, `HeaderClientState`, `HeaderPlacement`, `HeaderRootProps`
|
|
14
|
+
|
|
15
|
+
## Values
|
|
16
|
+
|
|
17
|
+
- `HeaderPlacement`: `"static" | "sticky"`
|
|
18
|
+
- `HeaderClientState`: `"top" | "visible" | "hidden"`
|
|
19
|
+
|
|
20
|
+
## Props and shapes
|
|
21
|
+
|
|
22
|
+
### HeaderRootProps
|
|
23
|
+
|
|
24
|
+
Extends: `ComponentPropsWithRef<"header">`
|
|
25
|
+
|
|
26
|
+
| Member | Type | Required | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| `placement` | `HeaderPlacement` | no | |
|
|
29
|
+
|
|
30
|
+
### HeaderClientProps
|
|
31
|
+
|
|
32
|
+
Extends: `HeaderRootProps`
|
|
33
|
+
|
|
34
|
+
| Member | Type | Required | Description |
|
|
35
|
+
| --- | --- | --- | --- |
|
|
36
|
+
| `hideOnScroll` | `boolean` | no | |
|
|
37
|
+
| `scrollTarget` | `string` | no | |
|
|
38
|
+
|
|
39
|
+
## Sub-entries
|
|
40
|
+
|
|
41
|
+
### `@gunkin/uiify/components/header/client`
|
|
42
|
+
|
|
43
|
+
- Runtime: `HeaderClient`
|
|
44
|
+
- Types: `HeaderClientProps`, `HeaderClientState`
|