@databricks/appkit-ui 0.89.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.
Files changed (82) hide show
  1. package/CLAUDE.md +8 -0
  2. package/dist/cli/commands/agent/eval.js +18 -2
  3. package/dist/cli/commands/agent/eval.js.map +1 -1
  4. package/dist/cli/commands/doctor/bundle.js +10 -1
  5. package/dist/cli/commands/doctor/bundle.js.map +1 -1
  6. package/dist/cli/commands/doctor/checks-wiring.js +1 -1
  7. package/dist/cli/commands/doctor/checks-wiring.js.map +1 -1
  8. package/dist/cli/commands/doctor/databricks-client.js +8 -3
  9. package/dist/cli/commands/doctor/databricks-client.js.map +1 -1
  10. package/dist/cli/commands/doctor/run.js +1 -1
  11. package/dist/cli/commands/doctor/run.js.map +1 -1
  12. package/dist/cli/commands/registry/add.js +6 -9
  13. package/dist/cli/commands/registry/add.js.map +1 -1
  14. package/dist/cli/commands/registry/client.js +9 -31
  15. package/dist/cli/commands/registry/client.js.map +1 -1
  16. package/dist/cli/commands/registry/constants.js +2 -41
  17. package/dist/cli/commands/registry/constants.js.map +1 -1
  18. package/dist/cli/commands/registry/info.js +1 -3
  19. package/dist/cli/commands/registry/info.js.map +1 -1
  20. package/dist/cli/commands/registry/list.js +5 -13
  21. package/dist/cli/commands/registry/list.js.map +1 -1
  22. package/dist/react/charts/area/index.d.ts.map +1 -1
  23. package/dist/react/charts/area/index.js.map +1 -1
  24. package/dist/react/charts/bar/index.d.ts.map +1 -1
  25. package/dist/react/charts/bar/index.js.map +1 -1
  26. package/dist/react/charts/heatmap/index.d.ts.map +1 -1
  27. package/dist/react/charts/heatmap/index.js.map +1 -1
  28. package/dist/react/charts/line/index.d.ts.map +1 -1
  29. package/dist/react/charts/line/index.js.map +1 -1
  30. package/dist/react/charts/pie/index.d.ts.map +1 -1
  31. package/dist/react/charts/pie/index.js.map +1 -1
  32. package/dist/react/charts/radar/index.d.ts.map +1 -1
  33. package/dist/react/charts/radar/index.js.map +1 -1
  34. package/dist/react/charts/scatter/index.d.ts.map +1 -1
  35. package/dist/react/charts/scatter/index.js.map +1 -1
  36. package/dist/react/ui/button.d.ts +1 -1
  37. package/docs/api/appkit/TypeAlias.IDatabaseConfig.md +12 -0
  38. package/docs/api/appkit-ui/data/AreaChart.md +82 -0
  39. package/docs/api/appkit-ui/data/BarChart.md +77 -0
  40. package/docs/api/appkit-ui/data/DonutChart.md +75 -0
  41. package/docs/api/appkit-ui/data/HeatmapChart.md +94 -0
  42. package/docs/api/appkit-ui/data/LineChart.md +80 -0
  43. package/docs/api/appkit-ui/data/PieChart.md +75 -0
  44. package/docs/api/appkit-ui/data/RadarChart.md +77 -0
  45. package/docs/api/appkit-ui/data/ScatterChart.md +79 -0
  46. package/docs/api/appkit-ui/genie/GenieChatMessageList.md +7 -7
  47. package/docs/api/appkit-ui/ui/Accordion.md +3 -3
  48. package/docs/api/appkit-ui/ui/ButtonGroup.md +5 -5
  49. package/docs/api/appkit-ui/ui/Calendar.md +7 -7
  50. package/docs/api/appkit-ui/ui/Carousel.md +1 -1
  51. package/docs/api/appkit-ui/ui/ContextMenu.md +13 -13
  52. package/docs/api/appkit-ui/ui/Drawer.md +1 -1
  53. package/docs/api/appkit-ui/ui/DropdownMenu.md +15 -15
  54. package/docs/api/appkit-ui/ui/Field.md +3 -3
  55. package/docs/api/appkit-ui/ui/HoverCard.md +4 -4
  56. package/docs/api/appkit-ui/ui/InputOTP.md +2 -2
  57. package/docs/api/appkit-ui/ui/Item.md +5 -5
  58. package/docs/api/appkit-ui/ui/Menubar.md +15 -15
  59. package/docs/api/appkit-ui/ui/NavigationMenu.md +11 -11
  60. package/docs/api/appkit-ui/ui/Popover.md +4 -4
  61. package/docs/api/appkit-ui/ui/RadioGroup.md +12 -12
  62. package/docs/api/appkit-ui/ui/ResizableHandle.md +23 -23
  63. package/docs/api/appkit-ui/ui/ScrollArea.md +11 -11
  64. package/docs/api/appkit-ui/ui/Select.md +10 -10
  65. package/docs/api/appkit-ui/ui/Separator.md +5 -5
  66. package/docs/api/appkit-ui/ui/Sheet.md +1 -1
  67. package/docs/api/appkit-ui/ui/Sidebar.md +15 -15
  68. package/docs/api/appkit-ui/ui/Slider.md +2 -2
  69. package/docs/api/appkit-ui/ui/Tabs.md +9 -9
  70. package/docs/api/appkit-ui/ui/Toaster.md +22 -22
  71. package/docs/api/appkit-ui/ui/ToggleGroup.md +3 -3
  72. package/docs/api/appkit-ui/ui/Tooltip.md +4 -4
  73. package/docs/development/llm-guide.md +1 -0
  74. package/docs/development/local-development.md +2 -0
  75. package/docs/plugins/agents.md +22 -22
  76. package/docs/plugins/caching.md +1 -1
  77. package/docs/plugins/database.md +11 -0
  78. package/docs/plugins/execution-context.md +1 -1
  79. package/docs/plugins/lakebase.md +3 -1
  80. package/llms.txt +8 -0
  81. package/package.json +1 -1
  82. package/sbom.cdx.json +1 -1
@@ -0,0 +1,77 @@
1
+ # RadarChart
2
+
3
+ Radar Chart component for multi-dimensional data comparison.
4
+
5
+ ## Example[​](#example "Direct link to Example")
6
+
7
+ ```tsx
8
+ "use client";
9
+
10
+ import { RadarChart } from "@databricks/appkit-ui/react";
11
+
12
+ export default function RadarChartExample() {
13
+ return (
14
+ <RadarChart
15
+ data={[
16
+ { skill: "Communication", score: 85 },
17
+ { skill: "Problem Solving", score: 90 },
18
+ { skill: "Teamwork", score: 75 },
19
+ { skill: "Leadership", score: 80 },
20
+ { skill: "Technical", score: 95 },
21
+ { skill: "Creativity", score: 70 },
22
+ ]}
23
+ xKey="skill"
24
+ yKey="score"
25
+ height={300}
26
+ />
27
+ );
28
+ }
29
+
30
+
31
+ ```
32
+
33
+ ## RadarChart[​](#radarchart-1 "Direct link to RadarChart")
34
+
35
+ Radar Chart component for multi-dimensional data comparison.
36
+
37
+ **Important:** This component uses Apache ECharts architecture. Configure it via props, not by passing child components.
38
+
39
+ **Best Practice:** Use the built-in data fetching by passing `queryKey` and `parameters` props instead of pre-fetching data with `useAnalyticsQuery`.
40
+
41
+ Supports both query mode (queryKey + parameters) and data mode (static data).
42
+
43
+ **Source:** [`packages/appkit-ui/src/react/charts/radar/index.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/radar/index.tsx)
44
+
45
+ ### Props[​](#props "Direct link to Props")
46
+
47
+ | Prop | Type | Required | Default | Description |
48
+ | ---------------- | --------------------------------------------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
49
+ | `queryKey` | `string` | | - | Analytics query key registered with analytics plugin |
50
+ | `parameters` | `Record<string, unknown>` | | - | Query parameters passed to the analytics endpoint |
51
+ | `format` | `"auto" \| "json_array" \| "arrow_stream" \| "json" \| "arrow"` | | `"auto"` | Data format to use - "json\_array": Use JSON format (smaller payloads, simpler) - "arrow\_stream": Use Arrow format (faster for large datasets) - "auto": Automatically select based on expected data size |
52
+ | `transformer` | `(<T>(data: T) => T)` | | - | Transform raw data before rendering |
53
+ | `data` | `ChartData` | | - | Arrow Table or JSON array |
54
+ | `title` | `string` | | - | Chart title |
55
+ | `showLegend` | `boolean` | | - | Show legend |
56
+ | `colorPalette` | `"categorical" \| "sequential" \| "diverging"` | | - | Color palette to use. Auto-selected based on chart type if not specified. - "categorical": Distinct colors for different categories (bar, pie, line) - "sequential": Gradient for magnitude/intensity (heatmap) - "diverging": Two-tone for positive/negative values |
57
+ | `colors` | `string[]` | | - | Custom colors for series (overrides colorPalette) |
58
+ | `height` | `number` | | `300` | Chart height in pixels |
59
+ | `className` | `string` | | - | Additional CSS classes |
60
+ | `xKey` | `string` | | - | X-axis field key. Auto-detected from schema if not provided. |
61
+ | `yKey` | `string \| string[]` | | - | Y-axis field key(s). Auto-detected from schema if not provided. |
62
+ | `ariaLabel` | `string` | | - | Accessibility label for screen readers |
63
+ | `testId` | `string` | | - | Test ID for automated testing |
64
+ | `options` | `Record<string, unknown>` | | - | Additional ECharts options to merge |
65
+ | `valueFormatter` | `ChartValueFormatter` | | - | Formats measure values in the chart's built-in value axes, tooltips, and value labels. `field` is the corresponding `yKey`, so one formatter can select a different format for each series. |
66
+ | `onDataClick` | `((datum: ChartClickDatum) => void)` | | - | Pointer-only: charts render to \<canvas>, so this does not fire for keyboard users. Provide a keyboard-accessible equivalent (e.g. a table row action) for the same action. |
67
+ | `selected` | `string \| string[]` | | - | Controlled selection by category name. Matching data element(s) render at full prominence while the rest are dimmed. Drive it from your own state to reflect a cross-filter or selection. Categorical charts (bar, pie/donut) show emphasis; other chart types ignore it. |
68
+ | `showArea` | `boolean` | | `true` | Show area fill |
69
+
70
+ ### Usage[​](#usage "Direct link to Usage")
71
+
72
+ ```tsx
73
+ import { RadarChart } from '@databricks/appkit-ui';
74
+
75
+ <RadarChart /* props */ />
76
+
77
+ ```
@@ -0,0 +1,79 @@
1
+ # ScatterChart
2
+
3
+ Scatter Chart component for correlation and distribution visualization.
4
+
5
+ ## Example[​](#example "Direct link to Example")
6
+
7
+ ```tsx
8
+ "use client";
9
+
10
+ import { ScatterChart } from "@databricks/appkit-ui/react";
11
+
12
+ export default function ScatterChartExample() {
13
+ return (
14
+ <ScatterChart
15
+ data={[
16
+ { revenue: 100, growth: 5 },
17
+ { revenue: 200, growth: 10 },
18
+ { revenue: 150, growth: 7 },
19
+ { revenue: 300, growth: 15 },
20
+ { revenue: 250, growth: 12 },
21
+ { revenue: 400, growth: 20 },
22
+ { revenue: 180, growth: 8 },
23
+ { revenue: 320, growth: 16 },
24
+ ]}
25
+ xKey="revenue"
26
+ yKey="growth"
27
+ height={300}
28
+ />
29
+ );
30
+ }
31
+
32
+
33
+ ```
34
+
35
+ ## ScatterChart[​](#scatterchart-1 "Direct link to ScatterChart")
36
+
37
+ Scatter Chart component for correlation and distribution visualization.
38
+
39
+ **Important:** This component uses Apache ECharts architecture. Configure it via props, not by passing child components.
40
+
41
+ **Best Practice:** Use the built-in data fetching by passing `queryKey` and `parameters` props instead of pre-fetching data with `useAnalyticsQuery`.
42
+
43
+ Supports both query mode (queryKey + parameters) and data mode (static data).
44
+
45
+ **Source:** [`packages/appkit-ui/src/react/charts/scatter/index.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/scatter/index.tsx)
46
+
47
+ ### Props[​](#props "Direct link to Props")
48
+
49
+ | Prop | Type | Required | Default | Description |
50
+ | ---------------- | --------------------------------------------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
51
+ | `queryKey` | `string` | | - | Analytics query key registered with analytics plugin |
52
+ | `parameters` | `Record<string, unknown>` | | - | Query parameters passed to the analytics endpoint |
53
+ | `format` | `"auto" \| "json_array" \| "arrow_stream" \| "json" \| "arrow"` | | `"auto"` | Data format to use - "json\_array": Use JSON format (smaller payloads, simpler) - "arrow\_stream": Use Arrow format (faster for large datasets) - "auto": Automatically select based on expected data size |
54
+ | `transformer` | `(<T>(data: T) => T)` | | - | Transform raw data before rendering |
55
+ | `data` | `ChartData` | | - | Arrow Table or JSON array |
56
+ | `title` | `string` | | - | Chart title |
57
+ | `showLegend` | `boolean` | | - | Show legend |
58
+ | `colorPalette` | `"categorical" \| "sequential" \| "diverging"` | | - | Color palette to use. Auto-selected based on chart type if not specified. - "categorical": Distinct colors for different categories (bar, pie, line) - "sequential": Gradient for magnitude/intensity (heatmap) - "diverging": Two-tone for positive/negative values |
59
+ | `colors` | `string[]` | | - | Custom colors for series (overrides colorPalette) |
60
+ | `height` | `number` | | `300` | Chart height in pixels |
61
+ | `className` | `string` | | - | Additional CSS classes |
62
+ | `xKey` | `string` | | - | X-axis field key. Auto-detected from schema if not provided. |
63
+ | `yKey` | `string \| string[]` | | - | Y-axis field key(s). Auto-detected from schema if not provided. |
64
+ | `ariaLabel` | `string` | | - | Accessibility label for screen readers |
65
+ | `testId` | `string` | | - | Test ID for automated testing |
66
+ | `options` | `Record<string, unknown>` | | - | Additional ECharts options to merge |
67
+ | `valueFormatter` | `ChartValueFormatter` | | - | Formats measure values in the chart's built-in value axes, tooltips, and value labels. `field` is the corresponding `yKey`, so one formatter can select a different format for each series. |
68
+ | `onDataClick` | `((datum: ChartClickDatum) => void)` | | - | Pointer-only: charts render to \<canvas>, so this does not fire for keyboard users. Provide a keyboard-accessible equivalent (e.g. a table row action) for the same action. |
69
+ | `selected` | `string \| string[]` | | - | Controlled selection by category name. Matching data element(s) render at full prominence while the rest are dimmed. Drive it from your own state to reflect a cross-filter or selection. Categorical charts (bar, pie/donut) show emphasis; other chart types ignore it. |
70
+ | `symbolSize` | `number` | | `8` | Symbol size |
71
+
72
+ ### Usage[​](#usage "Direct link to Usage")
73
+
74
+ ```tsx
75
+ import { ScatterChart } from '@databricks/appkit-ui';
76
+
77
+ <ScatterChart /* props */ />
78
+
79
+ ```
@@ -10,13 +10,13 @@ Scrollable message list that renders Genie chat messages with auto-scroll, skele
10
10
 
11
11
  ### Props[​](#props "Direct link to Props")
12
12
 
13
- | Prop | Type | Required | Default | Description |
14
- | --------------------- | -------------------- | -------- | ------- | --------------------------------------------------------------------------- |
15
- | `messages` | `GenieMessageItem[]` | ✓ | - | Array of messages to display |
16
- | `status` | `enum` | ✓ | - | Current chat status (controls loading indicators and skeleton placeholders) |
17
- | `className` | `string` | | - | Additional CSS class for the scroll area |
18
- | `hasPreviousPage` | `boolean` | | `false` | Whether a previous page of older messages exists |
19
- | `onFetchPreviousPage` | `(() => void)` | | - | Callback to fetch the previous page of messages |
13
+ | Prop | Type | Required | Default | Description |
14
+ | --------------------- | -------------------------------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------- |
15
+ | `messages` | `GenieMessageItem[]` | ✓ | - | Array of messages to display |
16
+ | `status` | `"idle" \| "error" \| "loading-history" \| "loading-older" \| "streaming"` | ✓ | - | Current chat status (controls loading indicators and skeleton placeholders) |
17
+ | `className` | `string` | | - | Additional CSS class for the scroll area |
18
+ | `hasPreviousPage` | `boolean` | | `false` | Whether a previous page of older messages exists |
19
+ | `onFetchPreviousPage` | `(() => void)` | | - | Callback to fetch the previous page of messages |
20
20
 
21
21
  ### Usage[​](#usage "Direct link to Usage")
22
22
 
@@ -53,14 +53,14 @@ Collapsible content sections organized in a vertical stack
53
53
 
54
54
  | Prop | Type | Required | Default | Description |
55
55
  | --------------- | ---------------------------------------------------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
56
- | `type` | `enum` | ✓ | - | - |
56
+ | `type` | `"single" \| "multiple"` | ✓ | - | - |
57
57
  | `value` | `string \| string[]` | | - | The controlled stateful value of the accordion item whose content is expanded. The controlled stateful value of the accordion items whose contents are expanded. |
58
58
  | `defaultValue` | `string \| string[]` | | - | The value of the item whose content is expanded when the accordion is initially rendered. Use `defaultValue` if you do not need to control the state of an accordion. The value of the items whose contents are expanded when the accordion is initially rendered. Use `defaultValue` if you do not need to control the state of an accordion. |
59
59
  | `onValueChange` | `((value: string) => void) \| ((value: string[]) => void)` | | - | The callback that fires when the state of the accordion changes. |
60
60
  | `collapsible` | `boolean` | | `false` | Whether an accordion item can be collapsed after it has been opened. |
61
61
  | `disabled` | `boolean` | | - | Whether or not an accordion is disabled from user interaction. @defaultValue false |
62
- | `orientation` | `enum` | | `vertical` | The layout in which the Accordion operates. |
63
- | `dir` | `enum` | | - | The language read direction. |
62
+ | `orientation` | `"horizontal" \| "vertical"` | | `vertical` | The layout in which the Accordion operates. |
63
+ | `dir` | `"ltr" \| "rtl"` | | - | The language read direction. |
64
64
  | `asChild` | `boolean` | | - | - |
65
65
 
66
66
  ### Usage[​](#usage "Direct link to Usage")
@@ -31,11 +31,11 @@ Visual separator between buttons in a button group
31
31
 
32
32
  ### Props[​](#props-1 "Direct link to Props")
33
33
 
34
- | Prop | Type | Required | Default | Description |
35
- | ------------- | --------- | -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
36
- | `orientation` | `enum` | | `vertical` | Either `vertical` or `horizontal`. Defaults to `horizontal`. |
37
- | `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. |
38
- | `asChild` | `boolean` | | - | - |
34
+ | Prop | Type | Required | Default | Description |
35
+ | ------------- | ---------------------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
36
+ | `orientation` | `"horizontal" \| "vertical"` | | `vertical` | Either `vertical` or `horizontal`. Defaults to `horizontal`. |
37
+ | `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. |
38
+ | `asChild` | `boolean` | | - | - |
39
39
 
40
40
  ### Usage[​](#usage-1 "Direct link to Usage")
41
41
 
@@ -38,7 +38,7 @@ Date picker component for selecting single dates or date ranges
38
38
 
39
39
  | Prop | Type | Required | Default | Description |
40
40
  | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
41
- | `mode` | `enum` | | - | Enable the selection of a single day, multiple days, or a range of days. @see <https://daypicker.dev/docs/selection-modes> |
41
+ | `mode` | `"single" \| "multiple" \| "range"` | | - | Enable the selection of a single day, multiple days, or a range of days. @see <https://daypicker.dev/docs/selection-modes> |
42
42
  | `required` | `boolean` | | - | Whether the selection is required. @see <https://daypicker.dev/docs/selection-modes> |
43
43
  | `className` | `string` | | - | Class name to add to the root element. |
44
44
  | `classNames` | `(Partial<ClassNames> & Partial<DeprecatedUI<string>>)` | | - | Change the class names used by DayPicker. |
@@ -62,9 +62,9 @@ Date picker component for selecting single dates or date ranges
62
62
  | `reverseMonths` | `boolean` | | - | Render the months in reversed order (when numberOfMonths is set) to display the most recent month first. @see <https://daypicker.dev/docs/customization#multiplemonths> |
63
63
  | `hideNavigation` | `boolean` | | - | Hide the navigation buttons. This prop won't disable the navigation: to disable the navigation, use disableNavigation. @since 9.0.0 @see <https://daypicker.dev/docs/navigation#hidenavigation> |
64
64
  | `disableNavigation` | `boolean` | | - | Disable the navigation between months. This prop won't hide the navigation: to hide the navigation, use hideNavigation. @see <https://daypicker.dev/docs/navigation#disablenavigation> |
65
- | `captionLayout` | `enum` | | `label` | Show dropdowns to navigate between months or years. |
65
+ | `captionLayout` | `"label" \| "dropdown" \| "dropdown-months" \| "dropdown-years"` | | `label` | Show dropdowns to navigate between months or years. |
66
66
  | `reverseYears` | `boolean` | | - | Reverse the order of years in the dropdown when using `captionLayout="dropdown"` or `captionLayout="dropdown-years"`. @since 9.9.0 @see <https://daypicker.dev/docs/customization#caption-layouts> |
67
- | `navLayout` | `enum` | | - | Adjust the positioning of the navigation buttons. |
67
+ | `navLayout` | `"around" \| "after"` | | - | Adjust the positioning of the navigation buttons. |
68
68
  | `fixedWeeks` | `boolean` | | - | Display always 6 weeks per each month, regardless of the month’s number of weeks. Weeks will be filled with the days from the next month. @see <https://daypicker.dev/docs/customization#fixed-weeks> |
69
69
  | `hideWeekdays` | `boolean` | | - | Hide the row displaying the weekday row header. @since 9.0.0 |
70
70
  | `showOutsideDays` | `boolean` | | `true` | Show the outside days (days falling in the next or the previous month). |
@@ -86,14 +86,14 @@ Date picker component for selecting single dates or date ranges
86
86
  | `dir` | `string` | | - | The text direction of the calendar. Use `ltr` for left-to-right (default) or `rtl` for right-to-left. @see <https://daypicker.dev/docs/translation#rtl-text-direction> |
87
87
  | `aria-label` | `string` | | - | The aria-label attribute to add to the container element. @since 9.4.1 @see <https://daypicker.dev/guides/accessibility> |
88
88
  | `aria-labelledby` | `string` | | - | The aria-labelledby attribute to add to the container element. @since 9.11.0 @see <https://daypicker.dev/guides/accessibility> |
89
- | `role` | `enum` | | - | The role attribute to add to the container element. @since 9.4.1 @see <https://daypicker.dev/guides/accessibility> |
89
+ | `role` | `"dialog" \| "application"` | | - | The role attribute to add to the container element. @since 9.4.1 @see <https://daypicker.dev/guides/accessibility> |
90
90
  | `nonce` | `string` | | - | A cryptographic nonce ("number used once") which can be used by Content Security Policy for the inline `style` attributes. |
91
91
  | `title` | `string` | | - | Add a `title` attribute to the container element. |
92
92
  | `lang` | `string` | | - | Add the language tag to the container element. |
93
93
  | `locale` | `Partial<DayPickerLocale>` | | - | The locale object used to localize dates. Pass a locale from `react-day-picker/locale` to localize the calendar. @example import { es } from "react-day-picker/locale"; \<DayPicker locale={es} /> @defaultValue enUS - The English locale default of `date-fns`. @see <https://daypicker.dev/docs/localization> @see <https://github.com/date-fns/date-fns/tree/main/src/locale> for a list of the supported locales |
94
- | `numerals` | `enum` | | - | The numeral system to use when formatting dates. |
95
- | `weekStartsOn` | `enum` | | - | The index of the first day of the week (0 - Sunday). Overrides the locale's default. @see <https://daypicker.dev/docs/localization#first-date-of-the-week> |
96
- | `firstWeekContainsDate` | `enum` | | - | The day of January that is always in the first week of the year. @see <https://daypicker.dev/docs/localization#first-week-contains-date> |
94
+ | `numerals` | `Numerals` | | - | The numeral system to use when formatting dates. |
95
+ | `weekStartsOn` | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6` | | - | The index of the first day of the week (0 - Sunday). Overrides the locale's default. @see <https://daypicker.dev/docs/localization#first-date-of-the-week> |
96
+ | `firstWeekContainsDate` | `1 \| 4` | | - | The day of January that is always in the first week of the year. @see <https://daypicker.dev/docs/localization#first-week-contains-date> |
97
97
  | `useAdditionalWeekYearTokens` | `boolean` | | - | Enable `DD` and `DDDD` for week year tokens when formatting or parsing dates. @see <https://date-fns.org/docs/Unicode-Tokens> |
98
98
  | `useAdditionalDayOfYearTokens` | `boolean` | | - | Enable `YY` and `YYYY` for day of year tokens when formatting or parsing dates. @see <https://date-fns.org/docs/Unicode-Tokens> |
99
99
  | `onMonthChange` | `MonthChangeEventHandler` | | - | Event fired when the user navigates between months. @see <https://daypicker.dev/docs/navigation#onmonthchange> |
@@ -55,7 +55,7 @@ Slideshow component for cycling through content with navigation controls
55
55
  | ------------- | ----------------------------------------- | -------- | ------------ | ----------- |
56
56
  | `opts` | `Partial<OptionsType>` | | - | - |
57
57
  | `plugins` | `CreatePluginType<LoosePluginType, {}>[]` | | - | - |
58
- | `orientation` | `enum` | | `horizontal` | - |
58
+ | `orientation` | `"horizontal" \| "vertical"` | | `horizontal` | - |
59
59
  | `setApi` | `((api: EmblaCarouselType) => void)` | | - | - |
60
60
 
61
61
  ### Usage[​](#usage "Direct link to Usage")
@@ -88,7 +88,7 @@ Menu triggered by right-clicking an element
88
88
  | Prop | Type | Required | Default | Description |
89
89
  | -------------- | --------------------------- | -------- | ------- | ----------- |
90
90
  | `onOpenChange` | `((open: boolean) => void)` | | - | - |
91
- | `dir` | `enum` | | - | - |
91
+ | `dir` | `"ltr" \| "rtl"` | | - | - |
92
92
  | `modal` | `boolean` | | - | - |
93
93
 
94
94
  ### Usage[​](#usage "Direct link to Usage")
@@ -145,9 +145,9 @@ import { ContextMenuCheckboxItem } from '@databricks/appkit-ui';
145
145
  | `avoidCollisions` | `boolean` | | - | - |
146
146
  | `collisionBoundary` | `Boundary \| Boundary[]` | | - | - |
147
147
  | `collisionPadding` | `number \| Partial<Record<"top" \| "right" \| "bottom" \| "left", number>>` | | - | - |
148
- | `sticky` | `enum` | | - | - |
148
+ | `sticky` | `"partial" \| "always"` | | - | - |
149
149
  | `hideWhenDetached` | `boolean` | | - | - |
150
- | `updatePositionStrategy` | `enum` | | - | - |
150
+ | `updatePositionStrategy` | `"always" \| "optimized"` | | - | - |
151
151
 
152
152
  ### Usage[​](#usage-2 "Direct link to Usage")
153
153
 
@@ -183,14 +183,14 @@ import { ContextMenuGroup } from '@databricks/appkit-ui';
183
183
 
184
184
  ### Props[​](#props-4 "Direct link to Props")
185
185
 
186
- | Prop | Type | Required | Default | Description |
187
- | ----------- | -------------------------- | -------- | --------- | ----------- |
188
- | `onSelect` | `((event: Event) => void)` | | - | - |
189
- | `asChild` | `boolean` | | - | - |
190
- | `disabled` | `boolean` | | - | - |
191
- | `textValue` | `string` | | - | - |
192
- | `inset` | `boolean` | | - | - |
193
- | `variant` | `enum` | | `default` | - |
186
+ | Prop | Type | Required | Default | Description |
187
+ | ----------- | ---------------------------- | -------- | --------- | ----------- |
188
+ | `onSelect` | `((event: Event) => void)` | | - | - |
189
+ | `asChild` | `boolean` | | - | - |
190
+ | `disabled` | `boolean` | | - | - |
191
+ | `textValue` | `string` | | - | - |
192
+ | `inset` | `boolean` | | - | - |
193
+ | `variant` | `"default" \| "destructive"` | | `default` | - |
194
194
 
195
195
  ### Usage[​](#usage-4 "Direct link to Usage")
196
196
 
@@ -363,9 +363,9 @@ import { ContextMenuSub } from '@databricks/appkit-ui';
363
363
  | `avoidCollisions` | `boolean` | | - | - |
364
364
  | `collisionBoundary` | `Boundary \| Boundary[]` | | - | - |
365
365
  | `collisionPadding` | `number \| Partial<Record<"top" \| "right" \| "bottom" \| "left", number>>` | | - | - |
366
- | `sticky` | `enum` | | - | - |
366
+ | `sticky` | `"partial" \| "always"` | | - | - |
367
367
  | `hideWhenDetached` | `boolean` | | - | - |
368
- | `updatePositionStrategy` | `enum` | | - | - |
368
+ | `updatePositionStrategy` | `"always" \| "optimized"` | | - | - |
369
369
 
370
370
  ### Usage[​](#usage-12 "Direct link to Usage")
371
371
 
@@ -115,7 +115,7 @@ Draggable panel that slides in from screen edges
115
115
  | `modal` | `boolean` | | `true` | When `false` it allows to interact with elements outside of the drawer without closing it. |
116
116
  | `nested` | `boolean` | | - | - |
117
117
  | `onClose` | `(() => void)` | | - | - |
118
- | `direction` | `enum` | | `'bottom'` | Direction of the drawer. Can be `top` or `bottom`, `left`, `right`. |
118
+ | `direction` | `"top" \| "right" \| "bottom" \| "left"` | | `'bottom'` | Direction of the drawer. Can be `top` or `bottom`, `left`, `right`. |
119
119
  | `defaultOpen` | `boolean` | | `false` | Opened by default, skips initial enter animation. Still reacts to `open` state changes |
120
120
  | `disablePreventScroll` | `boolean` | | `false` | When set to `true` prevents scrolling on the document body on mount, and restores it on unmount. |
121
121
  | `repositionInputs` | `boolean` | | `true when {@link snapPoints } is defined` | When `true` Vaul will reposition inputs rather than scroll then into view if the keyboard is in the way. Setting it to `false` will fall back to the default browser behavior. |
@@ -142,7 +142,7 @@ Menu that displays when triggered by a button or element
142
142
 
143
143
  | Prop | Type | Required | Default | Description |
144
144
  | -------------- | --------------------------- | -------- | ------- | ----------- |
145
- | `dir` | `enum` | | - | - |
145
+ | `dir` | `"ltr" \| "rtl"` | | - | - |
146
146
  | `open` | `boolean` | | - | - |
147
147
  | `defaultOpen` | `boolean` | | - | - |
148
148
  | `onOpenChange` | `((open: boolean) => void)` | | - | - |
@@ -197,17 +197,17 @@ import { DropdownMenuCheckboxItem } from '@databricks/appkit-ui';
197
197
  | `onInteractOutside` | `((event: FocusOutsideEvent \| PointerDownOutsideEvent) => void)` | | - | - |
198
198
  | `onCloseAutoFocus` | `((event: Event) => void)` | | - | Event handler called when auto-focusing on close. Can be prevented. |
199
199
  | `loop` | `boolean` | | - | Whether keyboard navigation should loop around @defaultValue false |
200
- | `side` | `enum` | | - | - |
200
+ | `side` | `"top" \| "right" \| "bottom" \| "left"` | | - | - |
201
201
  | `sideOffset` | `number` | | - | - |
202
- | `align` | `enum` | | - | - |
202
+ | `align` | `"center" \| "start" \| "end"` | | - | - |
203
203
  | `alignOffset` | `number` | | - | - |
204
204
  | `arrowPadding` | `number` | | - | - |
205
205
  | `avoidCollisions` | `boolean` | | - | - |
206
206
  | `collisionBoundary` | `Boundary \| Boundary[]` | | - | - |
207
207
  | `collisionPadding` | `number \| Partial<Record<"top" \| "right" \| "bottom" \| "left", number>>` | | - | - |
208
- | `sticky` | `enum` | | - | - |
208
+ | `sticky` | `"partial" \| "always"` | | - | - |
209
209
  | `hideWhenDetached` | `boolean` | | - | - |
210
- | `updatePositionStrategy` | `enum` | | - | - |
210
+ | `updatePositionStrategy` | `"always" \| "optimized"` | | - | - |
211
211
 
212
212
  ### Usage[​](#usage-2 "Direct link to Usage")
213
213
 
@@ -243,14 +243,14 @@ import { DropdownMenuGroup } from '@databricks/appkit-ui';
243
243
 
244
244
  ### Props[​](#props-4 "Direct link to Props")
245
245
 
246
- | Prop | Type | Required | Default | Description |
247
- | ----------- | -------------------------- | -------- | --------- | ----------- |
248
- | `onSelect` | `((event: Event) => void)` | | - | - |
249
- | `asChild` | `boolean` | | - | - |
250
- | `disabled` | `boolean` | | - | - |
251
- | `textValue` | `string` | | - | - |
252
- | `inset` | `boolean` | | - | - |
253
- | `variant` | `enum` | | `default` | - |
246
+ | Prop | Type | Required | Default | Description |
247
+ | ----------- | ---------------------------- | -------- | --------- | ----------- |
248
+ | `onSelect` | `((event: Event) => void)` | | - | - |
249
+ | `asChild` | `boolean` | | - | - |
250
+ | `disabled` | `boolean` | | - | - |
251
+ | `textValue` | `string` | | - | - |
252
+ | `inset` | `boolean` | | - | - |
253
+ | `variant` | `"default" \| "destructive"` | | `default` | - |
254
254
 
255
255
  ### Usage[​](#usage-4 "Direct link to Usage")
256
256
 
@@ -423,9 +423,9 @@ import { DropdownMenuSub } from '@databricks/appkit-ui';
423
423
  | `avoidCollisions` | `boolean` | | - | - |
424
424
  | `collisionBoundary` | `Boundary \| Boundary[]` | | - | - |
425
425
  | `collisionPadding` | `number \| Partial<Record<"top" \| "right" \| "bottom" \| "left", number>>` | | - | - |
426
- | `sticky` | `enum` | | - | - |
426
+ | `sticky` | `"partial" \| "always"` | | - | - |
427
427
  | `hideWhenDetached` | `boolean` | | - | - |
428
- | `updatePositionStrategy` | `enum` | | - | - |
428
+ | `updatePositionStrategy` | `"always" \| "optimized"` | | - | - |
429
429
 
430
430
  ### Usage[​](#usage-12 "Direct link to Usage")
431
431
 
@@ -130,9 +130,9 @@ Title or caption for a fieldset
130
130
 
131
131
  ### Props[​](#props-6 "Direct link to Props")
132
132
 
133
- | Prop | Type | Required | Default | Description |
134
- | --------- | ------ | -------- | -------- | ----------- |
135
- | `variant` | `enum` | | `legend` | - |
133
+ | Prop | Type | Required | Default | Description |
134
+ | --------- | --------------------- | -------- | -------- | ----------- |
135
+ | `variant` | `"label" \| "legend"` | | `legend` | - |
136
136
 
137
137
  ### Usage[​](#usage-6 "Direct link to Usage")
138
138
 
@@ -90,17 +90,17 @@ import { HoverCard } from '@databricks/appkit-ui';
90
90
  | `onFocusOutside` | `((event: FocusOutsideEvent) => void)` | | - | Event handler called when the focus moves outside of the `HoverCard`. Can be prevented. |
91
91
  | `onInteractOutside` | `((event: FocusOutsideEvent \| PointerDownOutsideEvent) => void)` | | - | Event handler called when an interaction happens outside the `HoverCard`. Specifically, when a `pointerdown` event happens outside or focus moves outside of it. Can be prevented. |
92
92
  | `asChild` | `boolean` | | - | - |
93
- | `side` | `enum` | | - | - |
93
+ | `side` | `"top" \| "right" \| "bottom" \| "left"` | | - | - |
94
94
  | `sideOffset` | `number` | | - | - |
95
- | `align` | `enum` | | - | - |
95
+ | `align` | `"center" \| "start" \| "end"` | | - | - |
96
96
  | `alignOffset` | `number` | | - | - |
97
97
  | `arrowPadding` | `number` | | - | - |
98
98
  | `avoidCollisions` | `boolean` | | - | - |
99
99
  | `collisionBoundary` | `Boundary \| Boundary[]` | | - | - |
100
100
  | `collisionPadding` | `number \| Partial<Record<"top" \| "right" \| "bottom" \| "left", number>>` | | - | - |
101
- | `sticky` | `enum` | | - | - |
101
+ | `sticky` | `"partial" \| "always"` | | - | - |
102
102
  | `hideWhenDetached` | `boolean` | | - | - |
103
- | `updatePositionStrategy` | `enum` | | - | - |
103
+ | `updatePositionStrategy` | `"always" \| "optimized"` | | - | - |
104
104
 
105
105
  ### Usage[​](#usage-1 "Direct link to Usage")
106
106
 
@@ -47,9 +47,9 @@ One-time password input with individual character slots
47
47
  | `value` | `string` | | - | - |
48
48
  | `onChange` | `((newValue: string) => unknown)` | | - | - |
49
49
  | `maxLength` | `number` | ✓ | - | - |
50
- | `textAlign` | `enum` | | - | - |
50
+ | `textAlign` | `"center" \| "right" \| "left"` | | - | - |
51
51
  | `onComplete` | `((...args: any[]) => unknown)` | | - | - |
52
- | `pushPasswordManagerStrategy` | `enum` | | - | - |
52
+ | `pushPasswordManagerStrategy` | `"none" \| "increase-width"` | | - | - |
53
53
  | `pasteTransformer` | `((pasted: string) => string)` | | - | - |
54
54
  | `containerClassName` | `string` | | - | - |
55
55
  | `noScriptCSSFallback` | `string \| null` | | - | - |
@@ -152,11 +152,11 @@ import { ItemMedia } from '@databricks/appkit-ui';
152
152
 
153
153
  ### Props[​](#props-8 "Direct link to Props")
154
154
 
155
- | Prop | Type | Required | Default | Description |
156
- | ------------- | --------- | -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
157
- | `orientation` | `enum` | | `vertical` | Either `vertical` or `horizontal`. Defaults to `horizontal`. |
158
- | `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. |
159
- | `asChild` | `boolean` | | - | - |
155
+ | Prop | Type | Required | Default | Description |
156
+ | ------------- | ---------------------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
157
+ | `orientation` | `"horizontal" \| "vertical"` | | `vertical` | Either `vertical` or `horizontal`. Defaults to `horizontal`. |
158
+ | `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. |
159
+ | `asChild` | `boolean` | | - | - |
160
160
 
161
161
  ### Usage[​](#usage-8 "Direct link to Usage")
162
162