@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
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","names":[],"sources":["../../../../src/react/charts/scatter/index.tsx"],"mappings":";;;;;;;AAcA;;;;;;cAAa,YAAA;EAAA,QAGZ,iBAAA,GAAA,kBAAA,CAAA,GAAA,CAAA,OAAA"}
1
+ {"version":3,"file":"index.d.ts","names":[],"sources":["../../../../src/react/charts/scatter/index.tsx"],"mappings":";;;;;;;AAYA;;;;;;cAAa,YAAA;EAAA,QAGZ,iBAAA,GAAA,kBAAA,CAAA,GAAA,CAAA,OAAA"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":[],"sources":["../../../../src/react/charts/scatter/index.tsx"],"sourcesContent":["import type { JSX } from \"react\";\n\nimport { createChart } from \"../create-chart\";\nimport type { ScatterChartProps } from \"../types\";\n\n/**\n * Scatter Chart component for correlation and distribution visualization.\n *\n * **Important:** This component uses Apache ECharts architecture. Configure it via props, not by passing child components.\n *\n * **Best Practice:** Use the built-in data fetching by passing `queryKey` and `parameters` props instead of pre-fetching data with `useAnalyticsQuery`.\n *\n * Supports both query mode (queryKey + parameters) and data mode (static data).\n */\nexport const ScatterChart = createChart<ScatterChartProps>(\n \"scatter\",\n \"ScatterChart\",\n);\n\n// Type-only definition for documentation generation (not used at runtime)\n/**\n * Scatter Chart component for correlation and distribution visualization.\n *\n * **Important:** This component uses Apache ECharts architecture. Configure it via props, not by passing child components.\n *\n * **Best Practice:** Use the built-in data fetching by passing `queryKey` and `parameters` props instead of pre-fetching data with `useAnalyticsQuery`.\n *\n * Supports both query mode (queryKey + parameters) and data mode (static data).\n */\nfunction _ScatterChartDoc(props: ScatterChartProps): JSX.Element {\n return ScatterChart(props);\n}\n"],"mappings":";;;;;;;;;;;;AAcA,MAAa,eAAe,YAC1B,WACA,eACD"}
1
+ {"version":3,"file":"index.js","names":[],"sources":["../../../../src/react/charts/scatter/index.tsx"],"sourcesContent":["import { createChart } from \"../create-chart\";\nimport type { ScatterChartProps } from \"../types\";\n\n/**\n * Scatter Chart component for correlation and distribution visualization.\n *\n * **Important:** This component uses Apache ECharts architecture. Configure it via props, not by passing child components.\n *\n * **Best Practice:** Use the built-in data fetching by passing `queryKey` and `parameters` props instead of pre-fetching data with `useAnalyticsQuery`.\n *\n * Supports both query mode (queryKey + parameters) and data mode (static data).\n */\nexport const ScatterChart = createChart<ScatterChartProps>(\n \"scatter\",\n \"ScatterChart\",\n);\n"],"mappings":";;;;;;;;;;;;AAYA,MAAa,eAAe,YAC1B,WACA,eACD"}
@@ -5,7 +5,7 @@ import * as class_variance_authority_types0 from "class-variance-authority/types
5
5
 
6
6
  //#region src/react/ui/button.d.ts
7
7
  declare const buttonVariants: (props?: ({
8
- variant?: "default" | "destructive" | "secondary" | "outline" | "ghost" | "link" | null | undefined;
8
+ variant?: "default" | "link" | "destructive" | "secondary" | "outline" | "ghost" | null | undefined;
9
9
  size?: "default" | "sm" | "lg" | "icon" | "icon-sm" | "icon-lg" | null | undefined;
10
10
  } & class_variance_authority_types0.ClassProp) | undefined) => string;
11
11
  /** Clickable button with multiple variants and sizes */
@@ -4,6 +4,7 @@
4
4
  type IDatabaseConfig<TSchema> = {
5
5
  api?: DatabaseApiConfig<TSchema>;
6
6
  hooks?: { readonly [TTable in SchemaTableName<TSchema>]?: EntityHooks<TTable> };
7
+ pool?: DatabasePoolConfig;
7
8
  schema?: TSchema;
8
9
  };
9
10
 
@@ -48,6 +49,17 @@ readonly optional hooks: { readonly [TTable in SchemaTableName<TSchema>]?: Entit
48
49
 
49
50
  ***
50
51
 
52
+ ### pool?[​](#pool "Direct link to pool?")
53
+
54
+ ```ts
55
+ readonly optional pool: DatabasePoolConfig;
56
+
57
+ ```
58
+
59
+ Overrides for the connection pool. A warning is logged when callers queue because every connection is in use.
60
+
61
+ ***
62
+
51
63
  ### schema?[​](#schema "Direct link to schema?")
52
64
 
53
65
  ```ts
@@ -0,0 +1,82 @@
1
+ # AreaChart
2
+
3
+ Area Chart component for trend visualization with filled areas.
4
+
5
+ ## Example[​](#example "Direct link to Example")
6
+
7
+ ```tsx
8
+ "use client";
9
+
10
+ import { AreaChart } from "@databricks/appkit-ui/react";
11
+
12
+ export default function AreaChartExample() {
13
+ return (
14
+ <AreaChart
15
+ data={[
16
+ { month: "Jan", visitors: 1000, revenue: 5000 },
17
+ { month: "Feb", visitors: 1500, revenue: 7000 },
18
+ { month: "Mar", visitors: 2000, revenue: 9000 },
19
+ { month: "Apr", visitors: 1800, revenue: 8500 },
20
+ { month: "May", visitors: 2200, revenue: 10000 },
21
+ { month: "Jun", visitors: 2500, revenue: 11000 },
22
+ ]}
23
+ xKey="month"
24
+ yKey={["visitors", "revenue"]}
25
+ stacked
26
+ showLegend
27
+ height={300}
28
+ />
29
+ );
30
+ }
31
+
32
+
33
+ ```
34
+
35
+ ## AreaChart[​](#areachart-1 "Direct link to AreaChart")
36
+
37
+ Area Chart component for trend visualization with filled areas.
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/area/index.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/area/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
+ | `orientation` | `"horizontal" \| "vertical"` | | `"vertical"` | Chart orientation |
71
+ | `showSymbol` | `boolean` | | `false` | Show data point symbols |
72
+ | `smooth` | `boolean` | | `true` | Smooth line curves |
73
+ | `stacked` | `boolean` | | `false` | Stack areas |
74
+
75
+ ### Usage[​](#usage "Direct link to Usage")
76
+
77
+ ```tsx
78
+ import { AreaChart } from '@databricks/appkit-ui';
79
+
80
+ <AreaChart /* props */ />
81
+
82
+ ```
@@ -0,0 +1,77 @@
1
+ # BarChart
2
+
3
+ Bar Chart component for categorical comparisons.
4
+
5
+ ## Example[​](#example "Direct link to Example")
6
+
7
+ ```tsx
8
+ "use client";
9
+
10
+ import { BarChart } from "@databricks/appkit-ui/react";
11
+
12
+ export default function BarChartExample() {
13
+ return (
14
+ <BarChart
15
+ data={[
16
+ { category: "Product A", value: 100 },
17
+ { category: "Product B", value: 200 },
18
+ { category: "Product C", value: 150 },
19
+ { category: "Product D", value: 300 },
20
+ { category: "Product E", value: 250 },
21
+ ]}
22
+ xKey="category"
23
+ yKey="value"
24
+ height={300}
25
+ />
26
+ );
27
+ }
28
+
29
+
30
+ ```
31
+
32
+ ## BarChart[​](#barchart-1 "Direct link to BarChart")
33
+
34
+ Bar Chart component for categorical comparisons.
35
+
36
+ **Important:** This component uses Apache ECharts architecture. Configure it via props, not by passing child components.
37
+
38
+ **Best Practice:** Use the built-in data fetching by passing `queryKey` and `parameters` props instead of pre-fetching data with `useAnalyticsQuery`.
39
+
40
+ Supports both query mode (queryKey + parameters) and data mode (static data).
41
+
42
+ **Source:** [`packages/appkit-ui/src/react/charts/bar/index.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/bar/index.tsx)
43
+
44
+ ### Props[​](#props "Direct link to Props")
45
+
46
+ | Prop | Type | Required | Default | Description |
47
+ | ---------------- | --------------------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
48
+ | `queryKey` | `string` | | - | Analytics query key registered with analytics plugin |
49
+ | `parameters` | `Record<string, unknown>` | | - | Query parameters passed to the analytics endpoint |
50
+ | `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 |
51
+ | `transformer` | `(<T>(data: T) => T)` | | - | Transform raw data before rendering |
52
+ | `data` | `ChartData` | | - | Arrow Table or JSON array |
53
+ | `title` | `string` | | - | Chart title |
54
+ | `showLegend` | `boolean` | | - | Show legend |
55
+ | `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 |
56
+ | `colors` | `string[]` | | - | Custom colors for series (overrides colorPalette) |
57
+ | `height` | `number` | | `300` | Chart height in pixels |
58
+ | `className` | `string` | | - | Additional CSS classes |
59
+ | `xKey` | `string` | | - | X-axis field key. Auto-detected from schema if not provided. |
60
+ | `yKey` | `string \| string[]` | | - | Y-axis field key(s). Auto-detected from schema if not provided. |
61
+ | `ariaLabel` | `string` | | - | Accessibility label for screen readers |
62
+ | `testId` | `string` | | - | Test ID for automated testing |
63
+ | `options` | `Record<string, unknown>` | | - | Additional ECharts options to merge |
64
+ | `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. |
65
+ | `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. |
66
+ | `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. |
67
+ | `orientation` | `"horizontal" \| "vertical"` | | `"vertical"` | Chart orientation |
68
+ | `stacked` | `boolean` | | - | Stack bars |
69
+
70
+ ### Usage[​](#usage "Direct link to Usage")
71
+
72
+ ```tsx
73
+ import { BarChart } from '@databricks/appkit-ui';
74
+
75
+ <BarChart /* props */ />
76
+
77
+ ```
@@ -0,0 +1,75 @@
1
+ # DonutChart
2
+
3
+ Donut Chart component (Pie chart with inner radius).
4
+
5
+ ## Example[​](#example "Direct link to Example")
6
+
7
+ ```tsx
8
+ "use client";
9
+
10
+ import { DonutChart } from "@databricks/appkit-ui/react";
11
+
12
+ export default function DonutChartExample() {
13
+ return (
14
+ <DonutChart
15
+ data={[
16
+ { name: "Engineering", value: 450 },
17
+ { name: "Marketing", value: 250 },
18
+ { name: "Sales", value: 300 },
19
+ { name: "Operations", value: 200 },
20
+ ]}
21
+ height={300}
22
+ />
23
+ );
24
+ }
25
+
26
+
27
+ ```
28
+
29
+ ## DonutChart[​](#donutchart-1 "Direct link to DonutChart")
30
+
31
+ Donut Chart component (Pie chart with inner radius).
32
+
33
+ **Important:** This component uses Apache ECharts architecture. Configure it via props, not by passing child components.
34
+
35
+ **Best Practice:** Use the built-in data fetching by passing `queryKey` and `parameters` props instead of pre-fetching data with `useAnalyticsQuery`.
36
+
37
+ Supports both query mode (queryKey + parameters) and data mode (static data).
38
+
39
+ **Source:** [`packages/appkit-ui/src/react/charts/pie/index.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/pie/index.tsx)
40
+
41
+ ### Props[​](#props "Direct link to Props")
42
+
43
+ | Prop | Type | Required | Default | Description |
44
+ | ---------------- | --------------------------------------------------------------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
45
+ | `queryKey` | `string` | | - | Analytics query key registered with analytics plugin |
46
+ | `parameters` | `Record<string, unknown>` | | - | Query parameters passed to the analytics endpoint |
47
+ | `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 |
48
+ | `transformer` | `(<T>(data: T) => T)` | | - | Transform raw data before rendering |
49
+ | `data` | `ChartData` | | - | Arrow Table or JSON array |
50
+ | `title` | `string` | | - | Chart title |
51
+ | `showLegend` | `boolean` | | - | Show legend |
52
+ | `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 |
53
+ | `colors` | `string[]` | | - | Custom colors for series (overrides colorPalette) |
54
+ | `height` | `number` | | `300` | Chart height in pixels |
55
+ | `className` | `string` | | - | Additional CSS classes |
56
+ | `xKey` | `string` | | - | X-axis field key. Auto-detected from schema if not provided. |
57
+ | `yKey` | `string \| string[]` | | - | Y-axis field key(s). Auto-detected from schema if not provided. |
58
+ | `ariaLabel` | `string` | | - | Accessibility label for screen readers |
59
+ | `testId` | `string` | | - | Test ID for automated testing |
60
+ | `options` | `Record<string, unknown>` | | - | Additional ECharts options to merge |
61
+ | `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. |
62
+ | `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. |
63
+ | `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. |
64
+ | `innerRadius` | `number` | | `0` | Inner radius for donut charts (0-100%) |
65
+ | `showLabels` | `boolean` | | `true` | Show labels on slices |
66
+ | `labelPosition` | `"center" \| "outside" \| "inside"` | | `"outside"` | Label position |
67
+
68
+ ### Usage[​](#usage "Direct link to Usage")
69
+
70
+ ```tsx
71
+ import { DonutChart } from '@databricks/appkit-ui';
72
+
73
+ <DonutChart /* props */ />
74
+
75
+ ```
@@ -0,0 +1,94 @@
1
+ # HeatmapChart
2
+
3
+ Heatmap Chart component for matrix-style data visualization.
4
+
5
+ ## Example[​](#example "Direct link to Example")
6
+
7
+ ```tsx
8
+ "use client";
9
+
10
+ import { HeatmapChart } from "@databricks/appkit-ui/react";
11
+
12
+ export default function HeatmapChartExample() {
13
+ const data = [];
14
+ const days = ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"];
15
+ const hours = ["00:00", "04:00", "08:00", "12:00", "16:00", "20:00"];
16
+
17
+ for (const day of days) {
18
+ for (const hour of hours) {
19
+ data.push({
20
+ day,
21
+ hour,
22
+ count: Math.floor(Math.random() * 100),
23
+ });
24
+ }
25
+ }
26
+
27
+ return (
28
+ <HeatmapChart
29
+ data={data}
30
+ xKey="day"
31
+ yAxisKey="hour"
32
+ yKey="count"
33
+ height={300}
34
+ />
35
+ );
36
+ }
37
+
38
+
39
+ ```
40
+
41
+ ## HeatmapChart[​](#heatmapchart-1 "Direct link to HeatmapChart")
42
+
43
+ Heatmap Chart component for matrix-style data visualization.
44
+
45
+ **Important:** This component uses Apache ECharts architecture. Configure it via props, not by passing child components.
46
+
47
+ **Best Practice:** Use the built-in data fetching by passing `queryKey` and `parameters` props instead of pre-fetching data with `useAnalyticsQuery`.
48
+
49
+ Data should be in "long format" with three fields:
50
+
51
+ * xKey: X-axis category (columns)
52
+ * yAxisKey: Y-axis category (rows)
53
+ * yKey: The numeric value for each cell
54
+
55
+ Supports both query mode (queryKey + parameters) and data mode (static data).
56
+
57
+ **Source:** [`packages/appkit-ui/src/react/charts/heatmap/index.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/heatmap/index.tsx)
58
+
59
+ ### Props[​](#props "Direct link to Props")
60
+
61
+ | Prop | Type | Required | Default | Description |
62
+ | ---------------- | --------------------------------------------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
63
+ | `queryKey` | `string` | | - | Analytics query key registered with analytics plugin |
64
+ | `parameters` | `Record<string, unknown>` | | - | Query parameters passed to the analytics endpoint |
65
+ | `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 |
66
+ | `transformer` | `(<T>(data: T) => T)` | | - | Transform raw data before rendering |
67
+ | `data` | `ChartData` | | - | Arrow Table or JSON array |
68
+ | `title` | `string` | | - | Chart title |
69
+ | `showLegend` | `boolean` | | - | Show legend |
70
+ | `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 |
71
+ | `colors` | `string[]` | | - | Custom colors for series (overrides colorPalette) |
72
+ | `height` | `number` | | `300` | Chart height in pixels |
73
+ | `className` | `string` | | - | Additional CSS classes |
74
+ | `xKey` | `string` | | - | X-axis field key. Auto-detected from schema if not provided. |
75
+ | `yKey` | `string \| string[]` | | - | Y-axis field key(s). Auto-detected from schema if not provided. |
76
+ | `ariaLabel` | `string` | | - | Accessibility label for screen readers |
77
+ | `testId` | `string` | | - | Test ID for automated testing |
78
+ | `options` | `Record<string, unknown>` | | - | Additional ECharts options to merge |
79
+ | `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. |
80
+ | `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. |
81
+ | `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. |
82
+ | `yAxisKey` | `string` | | - | Field key for the Y-axis categories. For heatmaps, data should have: xKey (column), yAxisKey (row), and yKey (value). |
83
+ | `min` | `number` | | - | Min value for color scale (auto-detected if not provided) |
84
+ | `max` | `number` | | - | Max value for color scale (auto-detected if not provided) |
85
+ | `showLabels` | `boolean` | | `false` | Show value labels on cells |
86
+
87
+ ### Usage[​](#usage "Direct link to Usage")
88
+
89
+ ```tsx
90
+ import { HeatmapChart } from '@databricks/appkit-ui';
91
+
92
+ <HeatmapChart /* props */ />
93
+
94
+ ```
@@ -0,0 +1,80 @@
1
+ # LineChart
2
+
3
+ Line Chart component for time-series and trend visualization.
4
+
5
+ ## Example[​](#example "Direct link to Example")
6
+
7
+ ```tsx
8
+ "use client";
9
+
10
+ import { LineChart } from "@databricks/appkit-ui/react";
11
+
12
+ export default function LineChartExample() {
13
+ return (
14
+ <LineChart
15
+ data={[
16
+ { month: "Jan", sales: 100 },
17
+ { month: "Feb", sales: 150 },
18
+ { month: "Mar", sales: 200 },
19
+ { month: "Apr", sales: 180 },
20
+ { month: "May", sales: 220 },
21
+ { month: "Jun", sales: 250 },
22
+ ]}
23
+ xKey="month"
24
+ yKey="sales"
25
+ smooth
26
+ height={300}
27
+ />
28
+ );
29
+ }
30
+
31
+
32
+ ```
33
+
34
+ ## LineChart[​](#linechart-1 "Direct link to LineChart")
35
+
36
+ Line Chart component for time-series and trend visualization.
37
+
38
+ **Important:** This component uses Apache ECharts architecture. Configure it via props, not by passing child components.
39
+
40
+ **Best Practice:** Use the built-in data fetching by passing `queryKey` and `parameters` props instead of pre-fetching data with `useAnalyticsQuery`.
41
+
42
+ Supports both query mode (queryKey + parameters) and data mode (static data).
43
+
44
+ **Source:** [`packages/appkit-ui/src/react/charts/line/index.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/line/index.tsx)
45
+
46
+ ### Props[​](#props "Direct link to Props")
47
+
48
+ | Prop | Type | Required | Default | Description |
49
+ | ---------------- | --------------------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
50
+ | `queryKey` | `string` | | - | Analytics query key registered with analytics plugin |
51
+ | `parameters` | `Record<string, unknown>` | | - | Query parameters passed to the analytics endpoint |
52
+ | `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 |
53
+ | `transformer` | `(<T>(data: T) => T)` | | - | Transform raw data before rendering |
54
+ | `data` | `ChartData` | | - | Arrow Table or JSON array |
55
+ | `title` | `string` | | - | Chart title |
56
+ | `showLegend` | `boolean` | | - | Show legend |
57
+ | `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 |
58
+ | `colors` | `string[]` | | - | Custom colors for series (overrides colorPalette) |
59
+ | `height` | `number` | | `300` | Chart height in pixels |
60
+ | `className` | `string` | | - | Additional CSS classes |
61
+ | `xKey` | `string` | | - | X-axis field key. Auto-detected from schema if not provided. |
62
+ | `yKey` | `string \| string[]` | | - | Y-axis field key(s). Auto-detected from schema if not provided. |
63
+ | `ariaLabel` | `string` | | - | Accessibility label for screen readers |
64
+ | `testId` | `string` | | - | Test ID for automated testing |
65
+ | `options` | `Record<string, unknown>` | | - | Additional ECharts options to merge |
66
+ | `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. |
67
+ | `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. |
68
+ | `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. |
69
+ | `orientation` | `"horizontal" \| "vertical"` | | `"vertical"` | Chart orientation |
70
+ | `showSymbol` | `boolean` | | `false` | Show data point symbols |
71
+ | `smooth` | `boolean` | | `true` | Smooth line curves |
72
+
73
+ ### Usage[​](#usage "Direct link to Usage")
74
+
75
+ ```tsx
76
+ import { LineChart } from '@databricks/appkit-ui';
77
+
78
+ <LineChart /* props */ />
79
+
80
+ ```
@@ -0,0 +1,75 @@
1
+ # PieChart
2
+
3
+ Pie Chart component for proportional data visualization.
4
+
5
+ ## Example[​](#example "Direct link to Example")
6
+
7
+ ```tsx
8
+ "use client";
9
+
10
+ import { PieChart } from "@databricks/appkit-ui/react";
11
+
12
+ export default function PieChartExample() {
13
+ return (
14
+ <PieChart
15
+ data={[
16
+ { name: "Product A", value: 400 },
17
+ { name: "Product B", value: 300 },
18
+ { name: "Product C", value: 300 },
19
+ { name: "Product D", value: 200 },
20
+ ]}
21
+ height={300}
22
+ />
23
+ );
24
+ }
25
+
26
+
27
+ ```
28
+
29
+ ## PieChart[​](#piechart-1 "Direct link to PieChart")
30
+
31
+ Pie Chart component for proportional data visualization.
32
+
33
+ **Important:** This component uses Apache ECharts architecture. Configure it via props, not by passing child components.
34
+
35
+ **Best Practice:** Use the built-in data fetching by passing `queryKey` and `parameters` props instead of pre-fetching data with `useAnalyticsQuery`.
36
+
37
+ Supports both query mode (queryKey + parameters) and data mode (static data).
38
+
39
+ **Source:** [`packages/appkit-ui/src/react/charts/pie/index.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/pie/index.tsx)
40
+
41
+ ### Props[​](#props "Direct link to Props")
42
+
43
+ | Prop | Type | Required | Default | Description |
44
+ | ---------------- | --------------------------------------------------------------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
45
+ | `queryKey` | `string` | | - | Analytics query key registered with analytics plugin |
46
+ | `parameters` | `Record<string, unknown>` | | - | Query parameters passed to the analytics endpoint |
47
+ | `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 |
48
+ | `transformer` | `(<T>(data: T) => T)` | | - | Transform raw data before rendering |
49
+ | `data` | `ChartData` | | - | Arrow Table or JSON array |
50
+ | `title` | `string` | | - | Chart title |
51
+ | `showLegend` | `boolean` | | - | Show legend |
52
+ | `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 |
53
+ | `colors` | `string[]` | | - | Custom colors for series (overrides colorPalette) |
54
+ | `height` | `number` | | `300` | Chart height in pixels |
55
+ | `className` | `string` | | - | Additional CSS classes |
56
+ | `xKey` | `string` | | - | X-axis field key. Auto-detected from schema if not provided. |
57
+ | `yKey` | `string \| string[]` | | - | Y-axis field key(s). Auto-detected from schema if not provided. |
58
+ | `ariaLabel` | `string` | | - | Accessibility label for screen readers |
59
+ | `testId` | `string` | | - | Test ID for automated testing |
60
+ | `options` | `Record<string, unknown>` | | - | Additional ECharts options to merge |
61
+ | `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. |
62
+ | `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. |
63
+ | `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. |
64
+ | `innerRadius` | `number` | | `0` | Inner radius for donut charts (0-100%) |
65
+ | `showLabels` | `boolean` | | `true` | Show labels on slices |
66
+ | `labelPosition` | `"center" \| "outside" \| "inside"` | | `"outside"` | Label position |
67
+
68
+ ### Usage[​](#usage "Direct link to Usage")
69
+
70
+ ```tsx
71
+ import { PieChart } from '@databricks/appkit-ui';
72
+
73
+ <PieChart /* props */ />
74
+
75
+ ```