@databricks/appkit-ui 0.90.0 → 0.91.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CLAUDE.md +8 -0
- package/dist/cli/commands/agent/eval.js +18 -2
- package/dist/cli/commands/agent/eval.js.map +1 -1
- package/dist/cli/commands/doctor/bundle.js +10 -1
- package/dist/cli/commands/doctor/bundle.js.map +1 -1
- package/dist/cli/commands/doctor/checks-wiring.js +1 -1
- package/dist/cli/commands/doctor/checks-wiring.js.map +1 -1
- package/dist/cli/commands/doctor/databricks-client.js +8 -3
- package/dist/cli/commands/doctor/databricks-client.js.map +1 -1
- package/dist/cli/commands/doctor/run.js +1 -1
- package/dist/cli/commands/doctor/run.js.map +1 -1
- package/dist/react/charts/area/index.d.ts.map +1 -1
- package/dist/react/charts/area/index.js.map +1 -1
- package/dist/react/charts/bar/index.d.ts.map +1 -1
- package/dist/react/charts/bar/index.js.map +1 -1
- package/dist/react/charts/heatmap/index.d.ts.map +1 -1
- package/dist/react/charts/heatmap/index.js.map +1 -1
- package/dist/react/charts/line/index.d.ts.map +1 -1
- package/dist/react/charts/line/index.js.map +1 -1
- package/dist/react/charts/pie/index.d.ts.map +1 -1
- package/dist/react/charts/pie/index.js.map +1 -1
- package/dist/react/charts/radar/index.d.ts.map +1 -1
- package/dist/react/charts/radar/index.js.map +1 -1
- package/dist/react/charts/scatter/index.d.ts.map +1 -1
- package/dist/react/charts/scatter/index.js.map +1 -1
- package/docs/api/appkit-ui/data/AreaChart.md +82 -0
- package/docs/api/appkit-ui/data/BarChart.md +77 -0
- package/docs/api/appkit-ui/data/DonutChart.md +75 -0
- package/docs/api/appkit-ui/data/HeatmapChart.md +94 -0
- package/docs/api/appkit-ui/data/LineChart.md +80 -0
- package/docs/api/appkit-ui/data/PieChart.md +75 -0
- package/docs/api/appkit-ui/data/RadarChart.md +77 -0
- package/docs/api/appkit-ui/data/ScatterChart.md +79 -0
- package/docs/api/appkit-ui/genie/GenieChatMessageList.md +7 -7
- package/docs/api/appkit-ui/ui/Accordion.md +3 -3
- package/docs/api/appkit-ui/ui/ButtonGroup.md +5 -5
- package/docs/api/appkit-ui/ui/Calendar.md +7 -7
- package/docs/api/appkit-ui/ui/Carousel.md +1 -1
- package/docs/api/appkit-ui/ui/ContextMenu.md +13 -13
- package/docs/api/appkit-ui/ui/Drawer.md +1 -1
- package/docs/api/appkit-ui/ui/DropdownMenu.md +15 -15
- package/docs/api/appkit-ui/ui/Field.md +3 -3
- package/docs/api/appkit-ui/ui/HoverCard.md +4 -4
- package/docs/api/appkit-ui/ui/InputOTP.md +2 -2
- package/docs/api/appkit-ui/ui/Item.md +5 -5
- package/docs/api/appkit-ui/ui/Menubar.md +15 -15
- package/docs/api/appkit-ui/ui/NavigationMenu.md +11 -11
- package/docs/api/appkit-ui/ui/Popover.md +4 -4
- package/docs/api/appkit-ui/ui/RadioGroup.md +12 -12
- package/docs/api/appkit-ui/ui/ResizableHandle.md +23 -23
- package/docs/api/appkit-ui/ui/ScrollArea.md +11 -11
- package/docs/api/appkit-ui/ui/Select.md +10 -10
- package/docs/api/appkit-ui/ui/Separator.md +5 -5
- package/docs/api/appkit-ui/ui/Sheet.md +1 -1
- package/docs/api/appkit-ui/ui/Sidebar.md +15 -15
- package/docs/api/appkit-ui/ui/Slider.md +2 -2
- package/docs/api/appkit-ui/ui/Tabs.md +9 -9
- package/docs/api/appkit-ui/ui/Toaster.md +22 -22
- package/docs/api/appkit-ui/ui/ToggleGroup.md +3 -3
- package/docs/api/appkit-ui/ui/Tooltip.md +4 -4
- package/docs/development/llm-guide.md +1 -0
- package/docs/development/local-development.md +2 -0
- package/docs/plugins/agents.md +22 -22
- package/docs/plugins/caching.md +1 -1
- package/docs/plugins/execution-context.md +1 -1
- package/llms.txt +8 -0
- package/package.json +1 -1
- package/sbom.cdx.json +1 -1
|
@@ -131,7 +131,7 @@ Horizontal menu bar with dropdown menus
|
|
|
131
131
|
| `defaultValue` | `string` | | - | - |
|
|
132
132
|
| `onValueChange` | `((value: string) => void)` | | - | - |
|
|
133
133
|
| `loop` | `boolean` | | - | - |
|
|
134
|
-
| `dir` | `
|
|
134
|
+
| `dir` | `"ltr" \| "rtl"` | | - | - |
|
|
135
135
|
| `asChild` | `boolean` | | - | - |
|
|
136
136
|
|
|
137
137
|
### Usage[](#usage "Direct link to Usage")
|
|
@@ -183,17 +183,17 @@ import { MenubarCheckboxItem } from '@databricks/appkit-ui';
|
|
|
183
183
|
| `onInteractOutside` | `((event: FocusOutsideEvent \| PointerDownOutsideEvent) => void)` | | - | - |
|
|
184
184
|
| `onCloseAutoFocus` | `((event: Event) => void)` | | - | Event handler called when auto-focusing on close. Can be prevented. |
|
|
185
185
|
| `loop` | `boolean` | | - | Whether keyboard navigation should loop around @defaultValue false |
|
|
186
|
-
| `side` | `
|
|
186
|
+
| `side` | `"top" \| "right" \| "bottom" \| "left"` | | - | - |
|
|
187
187
|
| `sideOffset` | `number` | | - | - |
|
|
188
|
-
| `align` | `
|
|
188
|
+
| `align` | `"center" \| "start" \| "end"` | | - | - |
|
|
189
189
|
| `alignOffset` | `number` | | - | - |
|
|
190
190
|
| `arrowPadding` | `number` | | - | - |
|
|
191
191
|
| `avoidCollisions` | `boolean` | | - | - |
|
|
192
192
|
| `collisionBoundary` | `Boundary \| Boundary[]` | | - | - |
|
|
193
193
|
| `collisionPadding` | `number \| Partial<Record<"top" \| "right" \| "bottom" \| "left", number>>` | | - | - |
|
|
194
|
-
| `sticky` | `
|
|
194
|
+
| `sticky` | `"partial" \| "always"` | | - | - |
|
|
195
195
|
| `hideWhenDetached` | `boolean` | | - | - |
|
|
196
|
-
| `updatePositionStrategy` | `
|
|
196
|
+
| `updatePositionStrategy` | `"always" \| "optimized"` | | - | - |
|
|
197
197
|
|
|
198
198
|
### Usage[](#usage-2 "Direct link to Usage")
|
|
199
199
|
|
|
@@ -229,14 +229,14 @@ import { MenubarGroup } from '@databricks/appkit-ui';
|
|
|
229
229
|
|
|
230
230
|
### Props[](#props-4 "Direct link to Props")
|
|
231
231
|
|
|
232
|
-
| Prop | Type
|
|
233
|
-
| ----------- |
|
|
234
|
-
| `onSelect` | `((event: Event) => void)`
|
|
235
|
-
| `asChild` | `boolean`
|
|
236
|
-
| `disabled` | `boolean`
|
|
237
|
-
| `textValue` | `string`
|
|
238
|
-
| `inset` | `boolean`
|
|
239
|
-
| `variant` | `
|
|
232
|
+
| Prop | Type | Required | Default | Description |
|
|
233
|
+
| ----------- | ---------------------------- | -------- | --------- | ----------- |
|
|
234
|
+
| `onSelect` | `((event: Event) => void)` | | - | - |
|
|
235
|
+
| `asChild` | `boolean` | | - | - |
|
|
236
|
+
| `disabled` | `boolean` | | - | - |
|
|
237
|
+
| `textValue` | `string` | | - | - |
|
|
238
|
+
| `inset` | `boolean` | | - | - |
|
|
239
|
+
| `variant` | `"default" \| "destructive"` | | `default` | - |
|
|
240
240
|
|
|
241
241
|
### Usage[](#usage-4 "Direct link to Usage")
|
|
242
242
|
|
|
@@ -429,9 +429,9 @@ import { MenubarSub } from '@databricks/appkit-ui';
|
|
|
429
429
|
| `avoidCollisions` | `boolean` | | - | - |
|
|
430
430
|
| `collisionBoundary` | `Boundary \| Boundary[]` | | - | - |
|
|
431
431
|
| `collisionPadding` | `number \| Partial<Record<"top" \| "right" \| "bottom" \| "left", number>>` | | - | - |
|
|
432
|
-
| `sticky` | `
|
|
432
|
+
| `sticky` | `"partial" \| "always"` | | - | - |
|
|
433
433
|
| `hideWhenDetached` | `boolean` | | - | - |
|
|
434
|
-
| `updatePositionStrategy` | `
|
|
434
|
+
| `updatePositionStrategy` | `"always" \| "optimized"` | | - | - |
|
|
435
435
|
|
|
436
436
|
### Usage[](#usage-13 "Direct link to Usage")
|
|
437
437
|
|
|
@@ -159,17 +159,17 @@ Horizontal navigation menu with dropdown submenus
|
|
|
159
159
|
|
|
160
160
|
### Props[](#props "Direct link to Props")
|
|
161
161
|
|
|
162
|
-
| Prop | Type
|
|
163
|
-
| ------------------- |
|
|
164
|
-
| `value` | `string`
|
|
165
|
-
| `defaultValue` | `string`
|
|
166
|
-
| `onValueChange` | `((value: string) => void)`
|
|
167
|
-
| `dir` | `
|
|
168
|
-
| `orientation` | `
|
|
169
|
-
| `delayDuration` | `number`
|
|
170
|
-
| `skipDelayDuration` | `number`
|
|
171
|
-
| `asChild` | `boolean`
|
|
172
|
-
| `viewport` | `boolean`
|
|
162
|
+
| Prop | Type | Required | Default | Description |
|
|
163
|
+
| ------------------- | ---------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------ |
|
|
164
|
+
| `value` | `string` | | - | - |
|
|
165
|
+
| `defaultValue` | `string` | | - | - |
|
|
166
|
+
| `onValueChange` | `((value: string) => void)` | | - | - |
|
|
167
|
+
| `dir` | `"ltr" \| "rtl"` | | - | - |
|
|
168
|
+
| `orientation` | `"horizontal" \| "vertical"` | | - | - |
|
|
169
|
+
| `delayDuration` | `number` | | - | The duration from when the pointer enters the trigger until the tooltip gets opened. @defaultValue 200 |
|
|
170
|
+
| `skipDelayDuration` | `number` | | - | How much time a user has to enter another trigger without incurring a delay again. @defaultValue 300 |
|
|
171
|
+
| `asChild` | `boolean` | | - | - |
|
|
172
|
+
| `viewport` | `boolean` | | `true` | - |
|
|
173
173
|
|
|
174
174
|
### Usage[](#usage "Direct link to Usage")
|
|
175
175
|
|
|
@@ -132,17 +132,17 @@ import { PopoverAnchor } from '@databricks/appkit-ui';
|
|
|
132
132
|
| `onInteractOutside` | `((event: FocusOutsideEvent \| PointerDownOutsideEvent) => void)` | | - | Event handler called when an interaction happens outside the `DismissableLayer`. Specifically, when a `pointerdown` event happens outside or focus moves outside of it. Can be prevented. |
|
|
133
133
|
| `onOpenAutoFocus` | `((event: Event) => void)` | | - | Event handler called when auto-focusing on open. Can be prevented. |
|
|
134
134
|
| `onCloseAutoFocus` | `((event: Event) => void)` | | - | Event handler called when auto-focusing on close. Can be prevented. |
|
|
135
|
-
| `side` | `
|
|
135
|
+
| `side` | `"top" \| "right" \| "bottom" \| "left"` | | - | - |
|
|
136
136
|
| `sideOffset` | `number` | | - | - |
|
|
137
|
-
| `align` | `
|
|
137
|
+
| `align` | `"center" \| "start" \| "end"` | | - | - |
|
|
138
138
|
| `alignOffset` | `number` | | - | - |
|
|
139
139
|
| `arrowPadding` | `number` | | - | - |
|
|
140
140
|
| `avoidCollisions` | `boolean` | | - | - |
|
|
141
141
|
| `collisionBoundary` | `Boundary \| Boundary[]` | | - | - |
|
|
142
142
|
| `collisionPadding` | `number \| Partial<Record<"top" \| "right" \| "bottom" \| "left", number>>` | | - | - |
|
|
143
|
-
| `sticky` | `
|
|
143
|
+
| `sticky` | `"partial" \| "always"` | | - | - |
|
|
144
144
|
| `hideWhenDetached` | `boolean` | | - | - |
|
|
145
|
-
| `updatePositionStrategy` | `
|
|
145
|
+
| `updatePositionStrategy` | `"always" \| "optimized"` | | - | - |
|
|
146
146
|
|
|
147
147
|
### Usage[](#usage-2 "Direct link to Usage")
|
|
148
148
|
|
|
@@ -38,18 +38,18 @@ Group of radio buttons for selecting a single option
|
|
|
38
38
|
|
|
39
39
|
### Props[](#props "Direct link to Props")
|
|
40
40
|
|
|
41
|
-
| Prop | Type
|
|
42
|
-
| --------------- |
|
|
43
|
-
| `name` | `string`
|
|
44
|
-
| `required` | `boolean`
|
|
45
|
-
| `disabled` | `boolean`
|
|
46
|
-
| `dir` | `
|
|
47
|
-
| `orientation` | `
|
|
48
|
-
| `loop` | `boolean`
|
|
49
|
-
| `defaultValue` | `string`
|
|
50
|
-
| `value` | `string \| null`
|
|
51
|
-
| `onValueChange` | `((value: string) => void)`
|
|
52
|
-
| `asChild` | `boolean`
|
|
41
|
+
| Prop | Type | Required | Default | Description |
|
|
42
|
+
| --------------- | ---------------------------- | -------- | ------- | ----------- |
|
|
43
|
+
| `name` | `string` | | - | - |
|
|
44
|
+
| `required` | `boolean` | | - | - |
|
|
45
|
+
| `disabled` | `boolean` | | - | - |
|
|
46
|
+
| `dir` | `"ltr" \| "rtl"` | | - | - |
|
|
47
|
+
| `orientation` | `"horizontal" \| "vertical"` | | - | - |
|
|
48
|
+
| `loop` | `boolean` | | - | - |
|
|
49
|
+
| `defaultValue` | `string` | | - | - |
|
|
50
|
+
| `value` | `string \| null` | | - | - |
|
|
51
|
+
| `onValueChange` | `((value: string) => void)` | | - | - |
|
|
52
|
+
| `asChild` | `boolean` | | - | - |
|
|
53
53
|
|
|
54
54
|
### Usage[](#usage "Direct link to Usage")
|
|
55
55
|
|
|
@@ -65,7 +65,7 @@ Draggable handle for resizing panels
|
|
|
65
65
|
| `onFocus` | `(() => void)` | | - | - |
|
|
66
66
|
| `onPointerDown` | `(() => void)` | | - | - |
|
|
67
67
|
| `onPointerUp` | `(() => void)` | | - | - |
|
|
68
|
-
| `tagName` | `
|
|
68
|
+
| `tagName` | `keyof HTMLElementTagNameMap` | | - | - |
|
|
69
69
|
| `withHandle` | `boolean` | | - | - |
|
|
70
70
|
|
|
71
71
|
### Usage[](#usage "Direct link to Usage")
|
|
@@ -85,19 +85,19 @@ Individual resizable panel within a panel group
|
|
|
85
85
|
|
|
86
86
|
### Props[](#props-1 "Direct link to Props")
|
|
87
87
|
|
|
88
|
-
| Prop | Type
|
|
89
|
-
| --------------- |
|
|
90
|
-
| `collapsedSize` | `number`
|
|
91
|
-
| `collapsible` | `boolean`
|
|
92
|
-
| `defaultSize` | `number`
|
|
93
|
-
| `id` | `string`
|
|
94
|
-
| `maxSize` | `number`
|
|
95
|
-
| `minSize` | `number`
|
|
96
|
-
| `onCollapse` | `PanelOnCollapse`
|
|
97
|
-
| `onExpand` | `PanelOnExpand`
|
|
98
|
-
| `onResize` | `PanelOnResize`
|
|
99
|
-
| `order` | `number`
|
|
100
|
-
| `tagName` | `
|
|
88
|
+
| Prop | Type | Required | Default | Description |
|
|
89
|
+
| --------------- | ----------------------------- | -------- | ------- | ----------- |
|
|
90
|
+
| `collapsedSize` | `number` | | - | - |
|
|
91
|
+
| `collapsible` | `boolean` | | - | - |
|
|
92
|
+
| `defaultSize` | `number` | | - | - |
|
|
93
|
+
| `id` | `string` | | - | - |
|
|
94
|
+
| `maxSize` | `number` | | - | - |
|
|
95
|
+
| `minSize` | `number` | | - | - |
|
|
96
|
+
| `onCollapse` | `PanelOnCollapse` | | - | - |
|
|
97
|
+
| `onExpand` | `PanelOnExpand` | | - | - |
|
|
98
|
+
| `onResize` | `PanelOnResize` | | - | - |
|
|
99
|
+
| `order` | `number` | | - | - |
|
|
100
|
+
| `tagName` | `keyof HTMLElementTagNameMap` | | - | - |
|
|
101
101
|
|
|
102
102
|
### Usage[](#usage-1 "Direct link to Usage")
|
|
103
103
|
|
|
@@ -116,15 +116,15 @@ Container for resizable panel layout
|
|
|
116
116
|
|
|
117
117
|
### Props[](#props-2 "Direct link to Props")
|
|
118
118
|
|
|
119
|
-
| Prop | Type
|
|
120
|
-
| ------------------ |
|
|
121
|
-
| `autoSaveId` | `string \| null`
|
|
122
|
-
| `direction` | `
|
|
123
|
-
| `id` | `string \| null`
|
|
124
|
-
| `keyboardResizeBy` | `number \| null`
|
|
125
|
-
| `onLayout` | `PanelGroupOnLayout \| null`
|
|
126
|
-
| `storage` | `PanelGroupStorage`
|
|
127
|
-
| `tagName` | `
|
|
119
|
+
| Prop | Type | Required | Default | Description |
|
|
120
|
+
| ------------------ | ----------------------------- | -------- | ------- | ----------- |
|
|
121
|
+
| `autoSaveId` | `string \| null` | | - | - |
|
|
122
|
+
| `direction` | `"horizontal" \| "vertical"` | ✓ | - | - |
|
|
123
|
+
| `id` | `string \| null` | | - | - |
|
|
124
|
+
| `keyboardResizeBy` | `number \| null` | | - | - |
|
|
125
|
+
| `onLayout` | `PanelGroupOnLayout \| null` | | - | - |
|
|
126
|
+
| `storage` | `PanelGroupStorage` | | - | - |
|
|
127
|
+
| `tagName` | `keyof HTMLElementTagNameMap` | | - | - |
|
|
128
128
|
|
|
129
129
|
### Usage[](#usage-2 "Direct link to Usage")
|
|
130
130
|
|
|
@@ -43,12 +43,12 @@ Container with custom scrollbars for overflow content
|
|
|
43
43
|
|
|
44
44
|
### Props[](#props "Direct link to Props")
|
|
45
45
|
|
|
46
|
-
| Prop | Type
|
|
47
|
-
| ----------------- |
|
|
48
|
-
| `type` | `
|
|
49
|
-
| `dir` | `
|
|
50
|
-
| `scrollHideDelay` | `number`
|
|
51
|
-
| `asChild` | `boolean`
|
|
46
|
+
| Prop | Type | Required | Default | Description |
|
|
47
|
+
| ----------------- | ------------------------------------------- | -------- | ------- | ----------- |
|
|
48
|
+
| `type` | `"auto" \| "always" \| "scroll" \| "hover"` | | - | - |
|
|
49
|
+
| `dir` | `"ltr" \| "rtl"` | | - | - |
|
|
50
|
+
| `scrollHideDelay` | `number` | | - | - |
|
|
51
|
+
| `asChild` | `boolean` | | - | - |
|
|
52
52
|
|
|
53
53
|
### Usage[](#usage "Direct link to Usage")
|
|
54
54
|
|
|
@@ -67,11 +67,11 @@ Scrollbar component for the scroll area
|
|
|
67
67
|
|
|
68
68
|
### Props[](#props-1 "Direct link to Props")
|
|
69
69
|
|
|
70
|
-
| Prop | Type
|
|
71
|
-
| ------------- |
|
|
72
|
-
| `forceMount` | `true`
|
|
73
|
-
| `orientation` | `
|
|
74
|
-
| `asChild` | `boolean`
|
|
70
|
+
| Prop | Type | Required | Default | Description |
|
|
71
|
+
| ------------- | ---------------------------- | -------- | ---------- | ----------- |
|
|
72
|
+
| `forceMount` | `true` | | - | - |
|
|
73
|
+
| `orientation` | `"horizontal" \| "vertical"` | | `vertical` | - |
|
|
74
|
+
| `asChild` | `boolean` | | - | - |
|
|
75
75
|
|
|
76
76
|
### Usage[](#usage-1 "Direct link to Usage")
|
|
77
77
|
|
|
@@ -54,7 +54,7 @@ Dropdown control for selecting a value from a list
|
|
|
54
54
|
| `open` | `boolean` | | - | - |
|
|
55
55
|
| `defaultOpen` | `boolean` | | - | - |
|
|
56
56
|
| `onOpenChange` | `((open: boolean) => void)` | | - | - |
|
|
57
|
-
| `dir` | `
|
|
57
|
+
| `dir` | `"ltr" \| "rtl"` | | - | - |
|
|
58
58
|
| `name` | `string` | | - | - |
|
|
59
59
|
| `autoComplete` | `string` | | - | - |
|
|
60
60
|
| `disabled` | `boolean` | | - | - |
|
|
@@ -84,19 +84,19 @@ import { Select } from '@databricks/appkit-ui';
|
|
|
84
84
|
| `onCloseAutoFocus` | `((event: Event) => void)` | | - | Event handler called when auto-focusing on close. Can be prevented. |
|
|
85
85
|
| `onEscapeKeyDown` | `((event: KeyboardEvent) => void)` | | - | Event handler called when the escape key is down. Can be prevented. |
|
|
86
86
|
| `onPointerDownOutside` | `((event: PointerDownOutsideEvent) => void)` | | - | Event handler called when the a `pointerdown` event happens outside of the `DismissableLayer`. Can be prevented. |
|
|
87
|
-
| `position` | `
|
|
87
|
+
| `position` | `"item-aligned" \| "popper"` | | `popper` | - |
|
|
88
88
|
| `asChild` | `boolean` | | - | - |
|
|
89
|
-
| `side` | `
|
|
89
|
+
| `side` | `"top" \| "right" \| "bottom" \| "left"` | | - | - |
|
|
90
90
|
| `sideOffset` | `number` | | - | - |
|
|
91
|
-
| `align` | `
|
|
91
|
+
| `align` | `"center" \| "start" \| "end"` | | - | - |
|
|
92
92
|
| `alignOffset` | `number` | | - | - |
|
|
93
93
|
| `arrowPadding` | `number` | | - | - |
|
|
94
94
|
| `avoidCollisions` | `boolean` | | - | - |
|
|
95
95
|
| `collisionBoundary` | `Boundary \| Boundary[]` | | - | - |
|
|
96
96
|
| `collisionPadding` | `number \| Partial<Record<"top" \| "right" \| "bottom" \| "left", number>>` | | - | - |
|
|
97
|
-
| `sticky` | `
|
|
97
|
+
| `sticky` | `"partial" \| "always"` | | - | - |
|
|
98
98
|
| `hideWhenDetached` | `boolean` | | - | - |
|
|
99
|
-
| `updatePositionStrategy` | `
|
|
99
|
+
| `updatePositionStrategy` | `"always" \| "optimized"` | | - | - |
|
|
100
100
|
|
|
101
101
|
### Usage[](#usage-1 "Direct link to Usage")
|
|
102
102
|
|
|
@@ -232,10 +232,10 @@ import { SelectSeparator } from '@databricks/appkit-ui';
|
|
|
232
232
|
|
|
233
233
|
### Props[](#props-8 "Direct link to Props")
|
|
234
234
|
|
|
235
|
-
| Prop | Type
|
|
236
|
-
| --------- |
|
|
237
|
-
| `asChild` | `boolean`
|
|
238
|
-
| `size` | `
|
|
235
|
+
| Prop | Type | Required | Default | Description |
|
|
236
|
+
| --------- | ------------------- | -------- | --------- | ----------- |
|
|
237
|
+
| `asChild` | `boolean` | | - | - |
|
|
238
|
+
| `size` | `"default" \| "sm"` | | `default` | - |
|
|
239
239
|
|
|
240
240
|
### Usage[](#usage-8 "Direct link to Usage")
|
|
241
241
|
|
|
@@ -40,11 +40,11 @@ Visual divider line between content sections
|
|
|
40
40
|
|
|
41
41
|
### Props[](#props "Direct link to Props")
|
|
42
42
|
|
|
43
|
-
| Prop | Type
|
|
44
|
-
| ------------- |
|
|
45
|
-
| `orientation` | `
|
|
46
|
-
| `decorative` | `boolean`
|
|
47
|
-
| `asChild` | `boolean`
|
|
43
|
+
| Prop | Type | Required | Default | Description |
|
|
44
|
+
| ------------- | ---------------------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
45
|
+
| `orientation` | `"horizontal" \| "vertical"` | | `vertical` | Either `vertical` or `horizontal`. Defaults to `horizontal`. |
|
|
46
|
+
| `decorative` | `boolean` | | - | Whether or not the component is purely decorative. When true, accessibility-related attributes are updated so that that the rendered element is removed from the accessibility tree. |
|
|
47
|
+
| `asChild` | `boolean` | | - | - |
|
|
48
48
|
|
|
49
49
|
### Usage[](#usage "Direct link to Usage")
|
|
50
50
|
|
|
@@ -123,7 +123,7 @@ Main content area of the sheet
|
|
|
123
123
|
| `onInteractOutside` | `((event: FocusOutsideEvent \| PointerDownOutsideEvent) => void)` | | - | Event handler called when an interaction happens outside the `DismissableLayer`. Specifically, when a `pointerdown` event happens outside or focus moves outside of it. Can be prevented. |
|
|
124
124
|
| `onOpenAutoFocus` | `((event: Event) => void)` | | - | Event handler called when auto-focusing on open. Can be prevented. |
|
|
125
125
|
| `onCloseAutoFocus` | `((event: Event) => void)` | | - | Event handler called when auto-focusing on close. Can be prevented. |
|
|
126
|
-
| `side` | `
|
|
126
|
+
| `side` | `"top" \| "right" \| "bottom" \| "left"` | | `right` | - |
|
|
127
127
|
|
|
128
128
|
### Usage[](#usage-2 "Direct link to Usage")
|
|
129
129
|
|
|
@@ -275,11 +275,11 @@ Collapsible navigation sidebar with mobile support
|
|
|
275
275
|
|
|
276
276
|
### Props[](#props "Direct link to Props")
|
|
277
277
|
|
|
278
|
-
| Prop | Type
|
|
279
|
-
| ------------- |
|
|
280
|
-
| `side` | `
|
|
281
|
-
| `variant` | `
|
|
282
|
-
| `collapsible` | `
|
|
278
|
+
| Prop | Type | Required | Default | Description |
|
|
279
|
+
| ------------- | ------------------------------------ | -------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
|
280
|
+
| `side` | `"right" \| "left"` | | `left` | Which side of the viewport the sidebar appears on |
|
|
281
|
+
| `variant` | `"inset" \| "sidebar" \| "floating"` | | `sidebar` | Visual style: `"sidebar"` (standard with border), `"floating"` (rounded with shadow), or `"inset"` (content area gets rounded margin) |
|
|
282
|
+
| `collapsible` | `"none" \| "icon" \| "offcanvas"` | | `offcanvas` | Collapse behavior: `"offcanvas"` (slides off-screen), `"icon"` (collapses to icon width), or `"none"` (always expanded) |
|
|
283
283
|
|
|
284
284
|
### Usage[](#usage "Direct link to Usage")
|
|
285
285
|
|
|
@@ -615,11 +615,11 @@ Button for submenu items
|
|
|
615
615
|
|
|
616
616
|
### Props[](#props-17 "Direct link to Props")
|
|
617
617
|
|
|
618
|
-
| Prop | Type
|
|
619
|
-
| ---------- |
|
|
620
|
-
| `asChild` | `boolean`
|
|
621
|
-
| `size` | `
|
|
622
|
-
| `isActive` | `boolean`
|
|
618
|
+
| Prop | Type | Required | Default | Description |
|
|
619
|
+
| ---------- | -------------- | -------- | ------- | ------------------------------------------------------ |
|
|
620
|
+
| `asChild` | `boolean` | | `false` | Render as child element instead of default tag |
|
|
621
|
+
| `size` | `"sm" \| "md"` | | `md` | Text size of the submenu button |
|
|
622
|
+
| `isActive` | `boolean` | | `false` | Whether this submenu item is currently active/selected |
|
|
623
623
|
|
|
624
624
|
### Usage[](#usage-17 "Direct link to Usage")
|
|
625
625
|
|
|
@@ -697,11 +697,11 @@ Visual separator between sidebar sections
|
|
|
697
697
|
|
|
698
698
|
### Props[](#props-21 "Direct link to Props")
|
|
699
699
|
|
|
700
|
-
| Prop | Type
|
|
701
|
-
| ------------- |
|
|
702
|
-
| `orientation` | `
|
|
703
|
-
| `decorative` | `boolean`
|
|
704
|
-
| `asChild` | `boolean`
|
|
700
|
+
| Prop | Type | Required | Default | Description |
|
|
701
|
+
| ------------- | ---------------------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
702
|
+
| `orientation` | `"horizontal" \| "vertical"` | | `vertical` | Either `vertical` or `horizontal`. Defaults to `horizontal`. |
|
|
703
|
+
| `decorative` | `boolean` | | - | Whether or not the component is purely decorative. When true, accessibility-related attributes are updated so that that the rendered element is removed from the accessibility tree. |
|
|
704
|
+
| `asChild` | `boolean` | | - | - |
|
|
705
705
|
|
|
706
706
|
### Usage[](#usage-21 "Direct link to Usage")
|
|
707
707
|
|
|
@@ -37,8 +37,8 @@ Draggable input for selecting numeric values within a range
|
|
|
37
37
|
| ----------------------- | ----------------------------- | -------- | ------- | ----------- |
|
|
38
38
|
| `name` | `string` | | - | - |
|
|
39
39
|
| `disabled` | `boolean` | | - | - |
|
|
40
|
-
| `orientation` | `
|
|
41
|
-
| `dir` | `
|
|
40
|
+
| `orientation` | `"horizontal" \| "vertical"` | | - | - |
|
|
41
|
+
| `dir` | `"ltr" \| "rtl"` | | - | - |
|
|
42
42
|
| `min` | `number` | | - | - |
|
|
43
43
|
| `max` | `number` | | - | - |
|
|
44
44
|
| `step` | `number` | | - | - |
|
|
@@ -90,15 +90,15 @@ Tabbed interface for organizing content into separate panels
|
|
|
90
90
|
|
|
91
91
|
### Props[](#props "Direct link to Props")
|
|
92
92
|
|
|
93
|
-
| Prop | Type
|
|
94
|
-
| ---------------- |
|
|
95
|
-
| `value` | `string`
|
|
96
|
-
| `defaultValue` | `string`
|
|
97
|
-
| `onValueChange` | `((value: string) => void)`
|
|
98
|
-
| `orientation` | `
|
|
99
|
-
| `dir` | `
|
|
100
|
-
| `activationMode` | `
|
|
101
|
-
| `asChild` | `boolean`
|
|
93
|
+
| Prop | Type | Required | Default | Description |
|
|
94
|
+
| ---------------- | ---------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
95
|
+
| `value` | `string` | | - | The value for the selected tab, if controlled |
|
|
96
|
+
| `defaultValue` | `string` | | - | The value of the tab to select by default, if uncontrolled |
|
|
97
|
+
| `onValueChange` | `((value: string) => void)` | | - | A function called when a new tab is selected |
|
|
98
|
+
| `orientation` | `"horizontal" \| "vertical"` | | - | The orientation the tabs are layed out. Mainly so arrow navigation is done accordingly (left & right vs. up & down) @defaultValue horizontal |
|
|
99
|
+
| `dir` | `"ltr" \| "rtl"` | | - | The direction of navigation between toolbar items. |
|
|
100
|
+
| `activationMode` | `"manual" \| "automatic"` | | - | Whether a tab is activated automatically or manually. @defaultValue automatic |
|
|
101
|
+
| `asChild` | `boolean` | | - | - |
|
|
102
102
|
|
|
103
103
|
### Usage[](#usage "Direct link to Usage")
|
|
104
104
|
|
|
@@ -42,28 +42,28 @@ Toast notification system for displaying temporary messages
|
|
|
42
42
|
|
|
43
43
|
### Props[](#props "Direct link to Props")
|
|
44
44
|
|
|
45
|
-
| Prop | Type
|
|
46
|
-
| -------------------- |
|
|
47
|
-
| `id` | `string`
|
|
48
|
-
| `invert` | `boolean`
|
|
49
|
-
| `theme` | `
|
|
50
|
-
| `position` | `
|
|
51
|
-
| `hotkey` | `string[]`
|
|
52
|
-
| `richColors` | `boolean`
|
|
53
|
-
| `expand` | `boolean`
|
|
54
|
-
| `duration` | `number`
|
|
55
|
-
| `gap` | `number`
|
|
56
|
-
| `visibleToasts` | `number`
|
|
57
|
-
| `closeButton` | `boolean`
|
|
58
|
-
| `toastOptions` | `ToastOptions`
|
|
59
|
-
| `className` | `string`
|
|
60
|
-
| `style` | `CSSProperties`
|
|
61
|
-
| `offset` | `Offset`
|
|
62
|
-
| `mobileOffset` | `Offset`
|
|
63
|
-
| `dir` | `
|
|
64
|
-
| `swipeDirections` | `SwipeDirection[]`
|
|
65
|
-
| `icons` | `ToastIcons`
|
|
66
|
-
| `containerAriaLabel` | `string`
|
|
45
|
+
| Prop | Type | Required | Default | Description |
|
|
46
|
+
| -------------------- | ------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
|
|
47
|
+
| `id` | `string` | | - | - |
|
|
48
|
+
| `invert` | `boolean` | | - | - |
|
|
49
|
+
| `theme` | `"light" \| "dark" \| "system"` | | - | - |
|
|
50
|
+
| `position` | `"top-left" \| "top-right" \| "bottom-left" \| "bottom-right" \| "top-center" \| "bottom-center"` | | - | - |
|
|
51
|
+
| `hotkey` | `string[]` | | - | - |
|
|
52
|
+
| `richColors` | `boolean` | | - | - |
|
|
53
|
+
| `expand` | `boolean` | | - | - |
|
|
54
|
+
| `duration` | `number` | | - | - |
|
|
55
|
+
| `gap` | `number` | | - | - |
|
|
56
|
+
| `visibleToasts` | `number` | | - | - |
|
|
57
|
+
| `closeButton` | `boolean` | | - | - |
|
|
58
|
+
| `toastOptions` | `ToastOptions` | | - | - |
|
|
59
|
+
| `className` | `string` | | - | - |
|
|
60
|
+
| `style` | `CSSProperties` | | - | - |
|
|
61
|
+
| `offset` | `Offset` | | - | - |
|
|
62
|
+
| `mobileOffset` | `Offset` | | - | - |
|
|
63
|
+
| `dir` | `"auto" \| "ltr" \| "rtl"` | | - | - |
|
|
64
|
+
| `swipeDirections` | `SwipeDirection[]` | | - | - |
|
|
65
|
+
| `icons` | `ToastIcons` | | - | - |
|
|
66
|
+
| `containerAriaLabel` | `string` | | - | - |
|
|
67
67
|
|
|
68
68
|
### Usage[](#usage "Direct link to Usage")
|
|
69
69
|
|
|
@@ -42,15 +42,15 @@ Group of toggle buttons for selecting one or more options
|
|
|
42
42
|
|
|
43
43
|
| Prop | Type | Required | Default | Description |
|
|
44
44
|
| --------------- | ---------------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
45
|
-
| `type` | `
|
|
45
|
+
| `type` | `"single" \| "multiple"` | ✓ | - | - |
|
|
46
46
|
| `value` | `string \| string[]` | | - | The controlled stateful value of the item that is pressed. The controlled stateful value of the items that are pressed. |
|
|
47
47
|
| `defaultValue` | `string \| string[]` | | - | The value of the item that is pressed when initially rendered. Use `defaultValue` if you do not need to control the state of a toggle group. The value of the items that are pressed when initially rendered. Use `defaultValue` if you do not need to control the state of a toggle group. |
|
|
48
48
|
| `onValueChange` | `((value: string) => void) \| ((value: string[]) => void)` | | - | The callback that fires when the value of the toggle group changes. The callback that fires when the state of the toggle group changes. |
|
|
49
49
|
| `disabled` | `boolean` | | - | Whether the group is disabled from user interaction. @defaultValue false |
|
|
50
50
|
| `rovingFocus` | `boolean` | | - | Whether the group should maintain roving focus of its buttons. @defaultValue true |
|
|
51
51
|
| `loop` | `boolean` | | - | - |
|
|
52
|
-
| `orientation` | `
|
|
53
|
-
| `dir` | `
|
|
52
|
+
| `orientation` | `"horizontal" \| "vertical"` | | - | - |
|
|
53
|
+
| `dir` | `"ltr" \| "rtl"` | | - | - |
|
|
54
54
|
| `asChild` | `boolean` | | - | - |
|
|
55
55
|
| `variant` | `"default" \| "outline" \| null` | | - | - |
|
|
56
56
|
| `size` | `"default" \| "sm" \| "lg" \| null` | | - | - |
|
|
@@ -70,17 +70,17 @@ import { Tooltip } from '@databricks/appkit-ui';
|
|
|
70
70
|
| `onEscapeKeyDown` | `((event: KeyboardEvent) => void)` | | - | Event handler called when the escape key is down. Can be prevented. |
|
|
71
71
|
| `onPointerDownOutside` | `((event: PointerDownOutsideEvent) => void)` | | - | Event handler called when the a `pointerdown` event happens outside of the `Tooltip`. Can be prevented. |
|
|
72
72
|
| `asChild` | `boolean` | | - | - |
|
|
73
|
-
| `side` | `
|
|
73
|
+
| `side` | `"top" \| "right" \| "bottom" \| "left"` | | - | - |
|
|
74
74
|
| `sideOffset` | `number` | | - | - |
|
|
75
|
-
| `align` | `
|
|
75
|
+
| `align` | `"center" \| "start" \| "end"` | | - | - |
|
|
76
76
|
| `alignOffset` | `number` | | - | - |
|
|
77
77
|
| `arrowPadding` | `number` | | - | - |
|
|
78
78
|
| `avoidCollisions` | `boolean` | | - | - |
|
|
79
79
|
| `collisionBoundary` | `Boundary \| Boundary[]` | | - | - |
|
|
80
80
|
| `collisionPadding` | `number \| Partial<Record<"top" \| "right" \| "bottom" \| "left", number>>` | | - | - |
|
|
81
|
-
| `sticky` | `
|
|
81
|
+
| `sticky` | `"partial" \| "always"` | | - | - |
|
|
82
82
|
| `hideWhenDetached` | `boolean` | | - | - |
|
|
83
|
-
| `updatePositionStrategy` | `
|
|
83
|
+
| `updatePositionStrategy` | `"always" \| "optimized"` | | - | - |
|
|
84
84
|
|
|
85
85
|
### Usage[](#usage-1 "Direct link to Usage")
|
|
86
86
|
|
|
@@ -66,6 +66,7 @@ Examples:
|
|
|
66
66
|
* `tsx` is in devDependencies for dev server
|
|
67
67
|
* `dev` script uses `NODE_ENV=development tsx watch server/server.ts`
|
|
68
68
|
* `client/index.html` exists with `<div id="root"></div>` and script pointing to `client/src/main.tsx`
|
|
69
|
+
* `typecheck` script passes. The dev server keeps serving an app with type errors, but logs them as `[appkit:server:typecheck]`, and deployment validation fails until they are fixed
|
|
69
70
|
|
|
70
71
|
### Backend[](#backend "Direct link to Backend")
|
|
71
72
|
|