From 4c41ea5447f06a215418d0a202a2f8d583cbd9d7 Mon Sep 17 00:00:00 2001 From: Pawel Kosiec Date: Wed, 21 Jan 2026 11:26:18 +0100 Subject: [PATCH 1/9] docs: generate `llms.txt` from the docs --- docs/docusaurus.config.ts | 31 +++++++++++++++++++++++++++++++ docs/package.json | 1 + 2 files changed, 32 insertions(+) diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 5aa932e..cc93a3a 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -3,6 +3,7 @@ import path from "node:path"; import type { Config } from "@docusaurus/types"; import type * as Preset from "@docusaurus/preset-classic"; import webpack from "webpack"; +import type { PluginOptions } from "@signalwire/docusaurus-plugin-llms-txt/public"; function appKitAliasPlugin() { return { @@ -123,6 +124,7 @@ const config: Config = { flattenOutputFiles: true, expandObjects: true, expandParameters: true, + disableSources: true, sidebar: { autoConfiguration: true, pretty: true, @@ -131,6 +133,35 @@ const config: Config = { }, ], appKitAliasPlugin, + [ + "@signalwire/docusaurus-plugin-llms-txt", + // docs: https://github.com/signalwire/docusaurus-plugins/blob/main/packages/docusaurus-plugin-llms-txt/README.md + { + id: "appkit", + markdown: { + enableFiles: true, + relativePaths: true, + includeDocs: true, + includeVersionedDocs: false, + includeBlog: false, + includePages: false, + includeGeneratedIndex: true, + }, + llmsTxt: { + siteTitle: "AppKit", + siteDescription: + "Node.js + React SDK for Databricks Apps. Built for humans and AI.", + enableLlmsFullTxt: true, + }, + ui: { + copyPageContent: { + display: { + docs: true, + }, + }, + }, + } satisfies PluginOptions, + ], ], themeConfig: { diff --git a/docs/package.json b/docs/package.json index 9bdca8f..658df19 100644 --- a/docs/package.json +++ b/docs/package.json @@ -24,6 +24,7 @@ "@docusaurus/preset-classic": "3.9.2", "@docusaurus/theme-mermaid": "^3.9.2", "@mdx-js/react": "^3.0.0", + "@signalwire/docusaurus-plugin-llms-txt": "2.0.0-alpha.7", "@tailwindcss/postcss": "^4.1.18", "clsx": "^2.0.0", "docusaurus-lunr-search": "^3.6.0", From aa9e37d2fc43b440e59757a00f0c0e9905f1481c Mon Sep 17 00:00:00 2001 From: Pawel Kosiec Date: Wed, 21 Jan 2026 11:37:16 +0100 Subject: [PATCH 2/9] docs: improve content for `llms.txt` generation --- .../api/appkit-ui/components/Accordion.mdx | 15 +- docs/docs/api/appkit-ui/components/Alert.mdx | 13 +- .../api/appkit-ui/components/AlertDialog.mdx | 29 +- .../api/appkit-ui/components/AspectRatio.mdx | 9 +- docs/docs/api/appkit-ui/components/Avatar.mdx | 13 +- docs/docs/api/appkit-ui/components/Badge.mdx | 9 +- .../api/appkit-ui/components/Breadcrumb.mdx | 21 +- docs/docs/api/appkit-ui/components/Button.mdx | 9 +- .../api/appkit-ui/components/ButtonGroup.mdx | 13 +- .../api/appkit-ui/components/Calendar.mdx | 11 +- docs/docs/api/appkit-ui/components/Card.mdx | 21 +- .../api/appkit-ui/components/Carousel.mdx | 17 +- docs/docs/api/appkit-ui/components/Chart.mdx | 9 +- .../api/appkit-ui/components/Checkbox.mdx | 9 +- .../api/appkit-ui/components/Collapsible.mdx | 13 +- .../docs/api/appkit-ui/components/Command.mdx | 25 +- .../api/appkit-ui/components/ContextMenu.mdx | 9 +- docs/docs/api/appkit-ui/components/Dialog.mdx | 27 +- docs/docs/api/appkit-ui/components/Drawer.mdx | 27 +- .../api/appkit-ui/components/DropdownMenu.mdx | 9 +- docs/docs/api/appkit-ui/components/Empty.mdx | 9 +- docs/docs/api/appkit-ui/components/Field.mdx | 27 +- docs/docs/api/appkit-ui/components/Form.mdx | 19 +- .../api/appkit-ui/components/HoverCard.mdx | 9 +- docs/docs/api/appkit-ui/components/Input.mdx | 9 +- .../api/appkit-ui/components/InputGroup.mdx | 19 +- .../api/appkit-ui/components/InputOtp.mdx | 15 +- docs/docs/api/appkit-ui/components/Item.mdx | 9 +- docs/docs/api/appkit-ui/components/Kbd.mdx | 9 +- docs/docs/api/appkit-ui/components/Label.mdx | 9 +- .../docs/api/appkit-ui/components/Menubar.mdx | 9 +- .../appkit-ui/components/NavigationMenu.mdx | 23 +- .../api/appkit-ui/components/Pagination.mdx | 21 +- .../docs/api/appkit-ui/components/Popover.mdx | 9 +- .../api/appkit-ui/components/Progress.mdx | 9 +- .../api/appkit-ui/components/RadioGroup.mdx | 9 +- .../api/appkit-ui/components/Resizable.mdx | 13 +- .../api/appkit-ui/components/ScrollArea.mdx | 11 +- docs/docs/api/appkit-ui/components/Select.mdx | 9 +- .../api/appkit-ui/components/Separator.mdx | 9 +- docs/docs/api/appkit-ui/components/Sheet.mdx | 23 +- .../docs/api/appkit-ui/components/Sidebar.mdx | 72 +++- .../api/appkit-ui/components/Skeleton.mdx | 9 +- docs/docs/api/appkit-ui/components/Slider.mdx | 9 +- docs/docs/api/appkit-ui/components/Sonner.mdx | 9 +- .../docs/api/appkit-ui/components/Spinner.mdx | 9 +- docs/docs/api/appkit-ui/components/Switch.mdx | 9 +- docs/docs/api/appkit-ui/components/Table.mdx | 9 +- docs/docs/api/appkit-ui/components/Tabs.mdx | 15 +- .../api/appkit-ui/components/Textarea.mdx | 9 +- docs/docs/api/appkit-ui/components/Toggle.mdx | 9 +- .../api/appkit-ui/components/ToggleGroup.mdx | 9 +- .../docs/api/appkit-ui/components/Tooltip.mdx | 11 +- docs/docs/api/appkit/Class.Plugin.md | 44 +-- .../api/appkit/Function.appKitTypesPlugin.md | 2 - docs/docs/api/appkit/Function.createApp.md | 2 - .../api/appkit/Function.isSQLTypeMarker.md | 2 - .../api/appkit/Interface.BasePluginConfig.md | 8 +- docs/docs/api/appkit/Interface.CacheConfig.md | 24 -- docs/docs/api/appkit/Interface.ITelemetry.md | 14 - .../Interface.StreamExecutionSettings.md | 8 +- .../api/appkit/Interface.TelemetryConfig.md | 12 +- docs/docs/api/appkit/TypeAlias.IAppRouter.md | 2 +- docs/docs/api/appkit/Variable.sql.md | 2 - docs/docs/api/appkit/index.md | 14 +- docs/docs/api/appkit/typedoc-sidebar.ts | 5 + docs/docs/index.md | 2 + packages/appkit-ui/src/react/ui/accordion.tsx | 4 + .../appkit-ui/src/react/ui/alert-dialog.tsx | 11 + packages/appkit-ui/src/react/ui/alert.tsx | 3 + .../appkit-ui/src/react/ui/aspect-ratio.tsx | 1 + packages/appkit-ui/src/react/ui/avatar.tsx | 3 + packages/appkit-ui/src/react/ui/badge.tsx | 1 + .../appkit-ui/src/react/ui/breadcrumb.tsx | 7 + .../appkit-ui/src/react/ui/button-group.tsx | 3 + packages/appkit-ui/src/react/ui/button.tsx | 1 + packages/appkit-ui/src/react/ui/calendar.tsx | 2 + packages/appkit-ui/src/react/ui/card.tsx | 7 + packages/appkit-ui/src/react/ui/carousel.tsx | 5 + packages/appkit-ui/src/react/ui/chart.tsx | 1 + packages/appkit-ui/src/react/ui/checkbox.tsx | 1 + .../appkit-ui/src/react/ui/collapsible.tsx | 3 + packages/appkit-ui/src/react/ui/command.tsx | 9 + .../appkit-ui/src/react/ui/context-menu.tsx | 1 + packages/appkit-ui/src/react/ui/dialog.tsx | 10 + packages/appkit-ui/src/react/ui/drawer.tsx | 10 + .../appkit-ui/src/react/ui/dropdown-menu.tsx | 1 + packages/appkit-ui/src/react/ui/empty.tsx | 1 + packages/appkit-ui/src/react/ui/field.tsx | 10 + packages/appkit-ui/src/react/ui/form.tsx | 7 + .../appkit-ui/src/react/ui/hover-card.tsx | 1 + .../appkit-ui/src/react/ui/input-group.tsx | 6 + packages/appkit-ui/src/react/ui/input-otp.tsx | 4 + packages/appkit-ui/src/react/ui/input.tsx | 1 + packages/appkit-ui/src/react/ui/item.tsx | 1 + packages/appkit-ui/src/react/ui/kbd.tsx | 1 + packages/appkit-ui/src/react/ui/label.tsx | 1 + packages/appkit-ui/src/react/ui/menubar.tsx | 1 + .../src/react/ui/navigation-menu.tsx | 8 + .../appkit-ui/src/react/ui/pagination.tsx | 7 + packages/appkit-ui/src/react/ui/popover.tsx | 1 + packages/appkit-ui/src/react/ui/progress.tsx | 1 + .../appkit-ui/src/react/ui/radio-group.tsx | 1 + packages/appkit-ui/src/react/ui/resizable.tsx | 3 + .../appkit-ui/src/react/ui/scroll-area.tsx | 2 + packages/appkit-ui/src/react/ui/select.tsx | 1 + packages/appkit-ui/src/react/ui/separator.tsx | 1 + packages/appkit-ui/src/react/ui/sheet.tsx | 10 + packages/appkit-ui/src/react/ui/sidebar.tsx | 22 ++ packages/appkit-ui/src/react/ui/skeleton.tsx | 1 + packages/appkit-ui/src/react/ui/slider.tsx | 1 + packages/appkit-ui/src/react/ui/sonner.tsx | 1 + packages/appkit-ui/src/react/ui/spinner.tsx | 1 + packages/appkit-ui/src/react/ui/switch.tsx | 1 + packages/appkit-ui/src/react/ui/table.tsx | 1 + packages/appkit-ui/src/react/ui/tabs.tsx | 4 + packages/appkit-ui/src/react/ui/textarea.tsx | 1 + .../appkit-ui/src/react/ui/toggle-group.tsx | 1 + packages/appkit-ui/src/react/ui/toggle.tsx | 1 + packages/appkit-ui/src/react/ui/tooltip.tsx | 2 + packages/appkit/src/index.ts | 7 + packages/appkit/src/plugin/plugin.ts | 1 + packages/appkit/src/telemetry/types.ts | 1 + packages/shared/src/execute.ts | 1 + packages/shared/src/plugin.ts | 3 + pnpm-lock.yaml | 371 ++++++++++++++---- tools/generate-component-mdx.ts | 11 +- 127 files changed, 1085 insertions(+), 407 deletions(-) diff --git a/docs/docs/api/appkit-ui/components/Accordion.mdx b/docs/docs/api/appkit-ui/components/Accordion.mdx index 9783ddb..b275e22 100644 --- a/docs/docs/api/appkit-ui/components/Accordion.mdx +++ b/docs/docs/api/appkit-ui/components/Accordion.mdx @@ -1,9 +1,8 @@ ---- -title: Accordion ---- - # Accordion +Collapsible content sections organized in a vertical stack + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Accordion +Collapsible content sections organized in a vertical stack + **Source:** [`packages/appkit-ui/src/react/ui/accordion.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/accordion.tsx) @@ -44,6 +45,8 @@ import { Accordion } from '@databricks/appkit-ui'; ## AccordionContent +Content area that expands and collapses within an accordion item + **Source:** [`packages/appkit-ui/src/react/ui/accordion.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/accordion.tsx) @@ -68,6 +71,8 @@ import { AccordionContent } from '@databricks/appkit-ui'; ## AccordionItem +Individual collapsible section within an accordion + **Source:** [`packages/appkit-ui/src/react/ui/accordion.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/accordion.tsx) @@ -93,6 +98,8 @@ import { AccordionItem } from '@databricks/appkit-ui'; ## AccordionTrigger +Clickable button that triggers accordion content visibility + **Source:** [`packages/appkit-ui/src/react/ui/accordion.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/accordion.tsx) diff --git a/docs/docs/api/appkit-ui/components/Alert.mdx b/docs/docs/api/appkit-ui/components/Alert.mdx index 4e5d511..0177265 100644 --- a/docs/docs/api/appkit-ui/components/Alert.mdx +++ b/docs/docs/api/appkit-ui/components/Alert.mdx @@ -1,9 +1,8 @@ ---- -title: Alert ---- - # Alert +Displays important information with optional icon and multiple variants + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Alert +Displays important information with optional icon and multiple variants + **Source:** [`packages/appkit-ui/src/react/ui/alert.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert.tsx) @@ -36,6 +37,8 @@ import { Alert } from '@databricks/appkit-ui'; ## AlertDescription +Descriptive text content for an alert component + **Source:** [`packages/appkit-ui/src/react/ui/alert.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert.tsx) @@ -57,6 +60,8 @@ import { AlertDescription } from '@databricks/appkit-ui'; ## AlertTitle +Title text for an alert component + **Source:** [`packages/appkit-ui/src/react/ui/alert.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert.tsx) diff --git a/docs/docs/api/appkit-ui/components/AlertDialog.mdx b/docs/docs/api/appkit-ui/components/AlertDialog.mdx index 7da88b4..79f5490 100644 --- a/docs/docs/api/appkit-ui/components/AlertDialog.mdx +++ b/docs/docs/api/appkit-ui/components/AlertDialog.mdx @@ -1,9 +1,8 @@ ---- -title: AlertDialog ---- - # AlertDialog +Modal dialog that interrupts the user with critical information requiring immediate action + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## AlertDialog +Modal dialog that interrupts the user with critical information requiring immediate action + **Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx) @@ -38,6 +39,8 @@ import { AlertDialog } from '@databricks/appkit-ui'; ## AlertDialogAction +Primary action button that confirms the alert + **Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx) @@ -61,6 +64,8 @@ import { AlertDialogAction } from '@databricks/appkit-ui'; ## AlertDialogCancel +Cancel button that dismisses the alert dialog + **Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx) @@ -84,6 +89,8 @@ import { AlertDialogCancel } from '@databricks/appkit-ui'; ## AlertDialogContent +Main content container for the alert dialog + **Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx) @@ -112,6 +119,8 @@ import { AlertDialogContent } from '@databricks/appkit-ui'; ## AlertDialogDescription +Descriptive text explaining the alert + **Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx) @@ -135,6 +144,8 @@ import { AlertDialogDescription } from '@databricks/appkit-ui'; ## AlertDialogFooter +Footer section containing action buttons + **Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx) @@ -156,6 +167,8 @@ import { AlertDialogFooter } from '@databricks/appkit-ui'; ## AlertDialogHeader +Header section containing title and description + **Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx) @@ -177,6 +190,8 @@ import { AlertDialogHeader } from '@databricks/appkit-ui'; ## AlertDialogOverlay +Background overlay that dims content behind the alert dialog + **Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx) @@ -201,6 +216,8 @@ import { AlertDialogOverlay } from '@databricks/appkit-ui'; ## AlertDialogPortal +Portal container for rendering alert dialog content outside the DOM hierarchy + **Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx) @@ -225,6 +242,8 @@ import { AlertDialogPortal } from '@databricks/appkit-ui'; ## AlertDialogTitle +Title heading for the alert dialog + **Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx) @@ -248,6 +267,8 @@ import { AlertDialogTitle } from '@databricks/appkit-ui'; ## AlertDialogTrigger +Button that triggers the alert dialog to open + **Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx) diff --git a/docs/docs/api/appkit-ui/components/AspectRatio.mdx b/docs/docs/api/appkit-ui/components/AspectRatio.mdx index 52c6102..f601d23 100644 --- a/docs/docs/api/appkit-ui/components/AspectRatio.mdx +++ b/docs/docs/api/appkit-ui/components/AspectRatio.mdx @@ -1,9 +1,8 @@ ---- -title: AspectRatio ---- - # AspectRatio +Container that maintains a specific aspect ratio for its content + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## AspectRatio +Container that maintains a specific aspect ratio for its content + **Source:** [`packages/appkit-ui/src/react/ui/aspect-ratio.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/aspect-ratio.tsx) diff --git a/docs/docs/api/appkit-ui/components/Avatar.mdx b/docs/docs/api/appkit-ui/components/Avatar.mdx index 1b16497..656858b 100644 --- a/docs/docs/api/appkit-ui/components/Avatar.mdx +++ b/docs/docs/api/appkit-ui/components/Avatar.mdx @@ -1,9 +1,8 @@ ---- -title: Avatar ---- - # Avatar +Displays user profile picture or initials in a circular container + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Avatar +Displays user profile picture or initials in a circular container + **Source:** [`packages/appkit-ui/src/react/ui/avatar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/avatar.tsx) @@ -36,6 +37,8 @@ import { Avatar } from '@databricks/appkit-ui'; ## AvatarFallback +Fallback content displayed when avatar image fails to load + **Source:** [`packages/appkit-ui/src/react/ui/avatar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/avatar.tsx) @@ -60,6 +63,8 @@ import { AvatarFallback } from '@databricks/appkit-ui'; ## AvatarImage +Image element for the avatar + **Source:** [`packages/appkit-ui/src/react/ui/avatar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/avatar.tsx) diff --git a/docs/docs/api/appkit-ui/components/Badge.mdx b/docs/docs/api/appkit-ui/components/Badge.mdx index dcca1f4..ce2862f 100644 --- a/docs/docs/api/appkit-ui/components/Badge.mdx +++ b/docs/docs/api/appkit-ui/components/Badge.mdx @@ -1,9 +1,8 @@ ---- -title: Badge ---- - # Badge +Small label for displaying status, categories, or counts + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Badge +Small label for displaying status, categories, or counts + **Source:** [`packages/appkit-ui/src/react/ui/badge.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/badge.tsx) diff --git a/docs/docs/api/appkit-ui/components/Breadcrumb.mdx b/docs/docs/api/appkit-ui/components/Breadcrumb.mdx index ad7f425..c480562 100644 --- a/docs/docs/api/appkit-ui/components/Breadcrumb.mdx +++ b/docs/docs/api/appkit-ui/components/Breadcrumb.mdx @@ -1,9 +1,8 @@ ---- -title: Breadcrumb ---- - # Breadcrumb +Navigation component showing the current page's location in the site hierarchy + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Breadcrumb +Navigation component showing the current page's location in the site hierarchy + **Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx) @@ -34,6 +35,8 @@ import { Breadcrumb } from '@databricks/appkit-ui'; ## BreadcrumbEllipsis +Ellipsis indicator for collapsed breadcrumb items + **Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx) @@ -55,6 +58,8 @@ import { BreadcrumbEllipsis } from '@databricks/appkit-ui'; ## BreadcrumbItem +Individual item in the breadcrumb trail + **Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx) @@ -76,6 +81,8 @@ import { BreadcrumbItem } from '@databricks/appkit-ui'; ## BreadcrumbLink +Clickable link within a breadcrumb item + **Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx) @@ -99,6 +106,8 @@ import { BreadcrumbLink } from '@databricks/appkit-ui'; ## BreadcrumbList +Ordered list container for breadcrumb items + **Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx) @@ -120,6 +129,8 @@ import { BreadcrumbList } from '@databricks/appkit-ui'; ## BreadcrumbPage +Current page indicator in the breadcrumb trail + **Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx) @@ -141,6 +152,8 @@ import { BreadcrumbPage } from '@databricks/appkit-ui'; ## BreadcrumbSeparator +Visual separator between breadcrumb items + **Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx) diff --git a/docs/docs/api/appkit-ui/components/Button.mdx b/docs/docs/api/appkit-ui/components/Button.mdx index e2610f8..46835d3 100644 --- a/docs/docs/api/appkit-ui/components/Button.mdx +++ b/docs/docs/api/appkit-ui/components/Button.mdx @@ -1,9 +1,8 @@ ---- -title: Button ---- - # Button +Clickable button with multiple variants and sizes + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Button +Clickable button with multiple variants and sizes + **Source:** [`packages/appkit-ui/src/react/ui/button.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/button.tsx) diff --git a/docs/docs/api/appkit-ui/components/ButtonGroup.mdx b/docs/docs/api/appkit-ui/components/ButtonGroup.mdx index 8d4568a..5888e39 100644 --- a/docs/docs/api/appkit-ui/components/ButtonGroup.mdx +++ b/docs/docs/api/appkit-ui/components/ButtonGroup.mdx @@ -1,11 +1,12 @@ ---- -title: ButtonGroup ---- - # ButtonGroup +Container for grouping related buttons together with shared borders + + ## ButtonGroup +Container for grouping related buttons together with shared borders + **Source:** [`packages/appkit-ui/src/react/ui/button-group.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/button-group.tsx) @@ -29,6 +30,8 @@ import { ButtonGroup } from '@databricks/appkit-ui'; ## ButtonGroupSeparator +Visual separator between buttons in a button group + **Source:** [`packages/appkit-ui/src/react/ui/button-group.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/button-group.tsx) @@ -54,6 +57,8 @@ import { ButtonGroupSeparator } from '@databricks/appkit-ui'; ## ButtonGroupText +Text label or content within a button group + **Source:** [`packages/appkit-ui/src/react/ui/button-group.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/button-group.tsx) diff --git a/docs/docs/api/appkit-ui/components/Calendar.mdx b/docs/docs/api/appkit-ui/components/Calendar.mdx index f4d03dc..57ac744 100644 --- a/docs/docs/api/appkit-ui/components/Calendar.mdx +++ b/docs/docs/api/appkit-ui/components/Calendar.mdx @@ -1,9 +1,8 @@ ---- -title: Calendar ---- - # Calendar +Date picker component for selecting single dates or date ranges + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Calendar +Date picker component for selecting single dates or date ranges + **Source:** [`packages/appkit-ui/src/react/ui/calendar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/calendar.tsx) @@ -118,6 +119,8 @@ import { Calendar } from '@databricks/appkit-ui'; ## CalendarDayButton +Individual day button within the calendar grid + **Source:** [`packages/appkit-ui/src/react/ui/calendar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/calendar.tsx) diff --git a/docs/docs/api/appkit-ui/components/Card.mdx b/docs/docs/api/appkit-ui/components/Card.mdx index f7b4a71..c1c01e2 100644 --- a/docs/docs/api/appkit-ui/components/Card.mdx +++ b/docs/docs/api/appkit-ui/components/Card.mdx @@ -1,9 +1,8 @@ ---- -title: Card ---- - # Card +Container for grouping related content with header, body, and footer sections + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Card +Container for grouping related content with header, body, and footer sections + **Source:** [`packages/appkit-ui/src/react/ui/card.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx) @@ -34,6 +35,8 @@ import { Card } from '@databricks/appkit-ui'; ## CardAction +Action buttons or controls positioned in the card header + **Source:** [`packages/appkit-ui/src/react/ui/card.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx) @@ -55,6 +58,8 @@ import { CardAction } from '@databricks/appkit-ui'; ## CardContent +Main content area of the card + **Source:** [`packages/appkit-ui/src/react/ui/card.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx) @@ -76,6 +81,8 @@ import { CardContent } from '@databricks/appkit-ui'; ## CardDescription +Descriptive text providing context for the card + **Source:** [`packages/appkit-ui/src/react/ui/card.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx) @@ -97,6 +104,8 @@ import { CardDescription } from '@databricks/appkit-ui'; ## CardFooter +Footer section for additional actions or information + **Source:** [`packages/appkit-ui/src/react/ui/card.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx) @@ -118,6 +127,8 @@ import { CardFooter } from '@databricks/appkit-ui'; ## CardHeader +Header section containing title, description, and actions + **Source:** [`packages/appkit-ui/src/react/ui/card.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx) @@ -139,6 +150,8 @@ import { CardHeader } from '@databricks/appkit-ui'; ## CardTitle +Title heading for the card + **Source:** [`packages/appkit-ui/src/react/ui/card.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx) diff --git a/docs/docs/api/appkit-ui/components/Carousel.mdx b/docs/docs/api/appkit-ui/components/Carousel.mdx index 4552786..263c003 100644 --- a/docs/docs/api/appkit-ui/components/Carousel.mdx +++ b/docs/docs/api/appkit-ui/components/Carousel.mdx @@ -1,9 +1,8 @@ ---- -title: Carousel ---- - # Carousel +Slideshow component for cycling through content with navigation controls + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Carousel +Slideshow component for cycling through content with navigation controls + **Source:** [`packages/appkit-ui/src/react/ui/carousel.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/carousel.tsx) @@ -39,6 +40,8 @@ import { Carousel } from '@databricks/appkit-ui'; ## CarouselContent +Container for carousel slides with horizontal or vertical scrolling + **Source:** [`packages/appkit-ui/src/react/ui/carousel.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/carousel.tsx) @@ -60,6 +63,8 @@ import { CarouselContent } from '@databricks/appkit-ui'; ## CarouselItem +Individual slide within the carousel + **Source:** [`packages/appkit-ui/src/react/ui/carousel.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/carousel.tsx) @@ -81,6 +86,8 @@ import { CarouselItem } from '@databricks/appkit-ui'; ## CarouselNext +Button to navigate to the next carousel slide + **Source:** [`packages/appkit-ui/src/react/ui/carousel.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/carousel.tsx) @@ -106,6 +113,8 @@ import { CarouselNext } from '@databricks/appkit-ui'; ## CarouselPrevious +Button to navigate to the previous carousel slide + **Source:** [`packages/appkit-ui/src/react/ui/carousel.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/carousel.tsx) diff --git a/docs/docs/api/appkit-ui/components/Chart.mdx b/docs/docs/api/appkit-ui/components/Chart.mdx index 67cfa66..20ce5d9 100644 --- a/docs/docs/api/appkit-ui/components/Chart.mdx +++ b/docs/docs/api/appkit-ui/components/Chart.mdx @@ -1,11 +1,12 @@ ---- -title: Chart ---- - # Chart +Container for rendering data visualizations using Recharts + + ## ChartContainer +Container for rendering data visualizations using Recharts + **Source:** [`packages/appkit-ui/src/react/ui/chart.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/chart.tsx) diff --git a/docs/docs/api/appkit-ui/components/Checkbox.mdx b/docs/docs/api/appkit-ui/components/Checkbox.mdx index 7edcdbd..63af8ac 100644 --- a/docs/docs/api/appkit-ui/components/Checkbox.mdx +++ b/docs/docs/api/appkit-ui/components/Checkbox.mdx @@ -1,9 +1,8 @@ ---- -title: Checkbox ---- - # Checkbox +Checkbox input for selecting multiple options + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Checkbox +Checkbox input for selecting multiple options + **Source:** [`packages/appkit-ui/src/react/ui/checkbox.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/checkbox.tsx) diff --git a/docs/docs/api/appkit-ui/components/Collapsible.mdx b/docs/docs/api/appkit-ui/components/Collapsible.mdx index 78391f5..4af5130 100644 --- a/docs/docs/api/appkit-ui/components/Collapsible.mdx +++ b/docs/docs/api/appkit-ui/components/Collapsible.mdx @@ -1,9 +1,8 @@ ---- -title: Collapsible ---- - # Collapsible +Interactive component that expands and collapses content + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Collapsible +Interactive component that expands and collapses content + **Source:** [`packages/appkit-ui/src/react/ui/collapsible.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/collapsible.tsx) @@ -40,6 +41,8 @@ import { Collapsible } from '@databricks/appkit-ui'; ## CollapsibleContent +Content area that can be expanded or collapsed + **Source:** [`packages/appkit-ui/src/react/ui/collapsible.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/collapsible.tsx) @@ -64,6 +67,8 @@ import { CollapsibleContent } from '@databricks/appkit-ui'; ## CollapsibleTrigger +Button that toggles the collapsible content visibility + **Source:** [`packages/appkit-ui/src/react/ui/collapsible.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/collapsible.tsx) diff --git a/docs/docs/api/appkit-ui/components/Command.mdx b/docs/docs/api/appkit-ui/components/Command.mdx index 6cca078..b882d5c 100644 --- a/docs/docs/api/appkit-ui/components/Command.mdx +++ b/docs/docs/api/appkit-ui/components/Command.mdx @@ -1,9 +1,8 @@ ---- -title: Command ---- - # Command +Command palette for keyboard-driven navigation and actions + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Command +Command palette for keyboard-driven navigation and actions + **Source:** [`packages/appkit-ui/src/react/ui/command.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx) @@ -44,6 +45,8 @@ import { Command } from '@databricks/appkit-ui'; ## CommandDialog +Dialog wrapper for the command palette + **Source:** [`packages/appkit-ui/src/react/ui/command.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx) @@ -74,6 +77,8 @@ import { CommandDialog } from '@databricks/appkit-ui'; ## CommandEmpty +Empty state displayed when no commands match the search + **Source:** [`packages/appkit-ui/src/react/ui/command.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx) @@ -97,6 +102,8 @@ import { CommandEmpty } from '@databricks/appkit-ui'; ## CommandGroup +Group of related command items with an optional heading + **Source:** [`packages/appkit-ui/src/react/ui/command.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx) @@ -123,6 +130,8 @@ import { CommandGroup } from '@databricks/appkit-ui'; ## CommandInput +Search input field for filtering command items + **Source:** [`packages/appkit-ui/src/react/ui/command.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx) @@ -148,6 +157,8 @@ import { CommandInput } from '@databricks/appkit-ui'; ## CommandItem +Individual selectable command item + **Source:** [`packages/appkit-ui/src/react/ui/command.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx) @@ -176,6 +187,8 @@ import { CommandItem } from '@databricks/appkit-ui'; ## CommandList +Scrollable list container for command items + **Source:** [`packages/appkit-ui/src/react/ui/command.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx) @@ -200,6 +213,8 @@ import { CommandList } from '@databricks/appkit-ui'; ## CommandSeparator +Visual separator between command groups + **Source:** [`packages/appkit-ui/src/react/ui/command.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx) @@ -224,6 +239,8 @@ import { CommandSeparator } from '@databricks/appkit-ui'; ## CommandShortcut +Keyboard shortcut indicator displayed next to command items + **Source:** [`packages/appkit-ui/src/react/ui/command.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx) diff --git a/docs/docs/api/appkit-ui/components/ContextMenu.mdx b/docs/docs/api/appkit-ui/components/ContextMenu.mdx index 453d0c1..874e02d 100644 --- a/docs/docs/api/appkit-ui/components/ContextMenu.mdx +++ b/docs/docs/api/appkit-ui/components/ContextMenu.mdx @@ -1,9 +1,8 @@ ---- -title: ContextMenu ---- - # ContextMenu +Menu triggered by right-clicking an element + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## ContextMenu +Menu triggered by right-clicking an element + **Source:** [`packages/appkit-ui/src/react/ui/context-menu.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx) diff --git a/docs/docs/api/appkit-ui/components/Dialog.mdx b/docs/docs/api/appkit-ui/components/Dialog.mdx index 3d7438f..7e226b2 100644 --- a/docs/docs/api/appkit-ui/components/Dialog.mdx +++ b/docs/docs/api/appkit-ui/components/Dialog.mdx @@ -1,9 +1,8 @@ ---- -title: Dialog ---- - # Dialog +Modal dialog that overlays the page content + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Dialog +Modal dialog that overlays the page content + **Source:** [`packages/appkit-ui/src/react/ui/dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx) @@ -39,6 +40,8 @@ import { Dialog } from '@databricks/appkit-ui'; ## DialogClose +Button that closes the dialog + **Source:** [`packages/appkit-ui/src/react/ui/dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx) @@ -62,6 +65,8 @@ import { DialogClose } from '@databricks/appkit-ui'; ## DialogContent +Main content area of the dialog + **Source:** [`packages/appkit-ui/src/react/ui/dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx) @@ -93,6 +98,8 @@ import { DialogContent } from '@databricks/appkit-ui'; ## DialogDescription +Description text for the dialog + **Source:** [`packages/appkit-ui/src/react/ui/dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx) @@ -116,6 +123,8 @@ import { DialogDescription } from '@databricks/appkit-ui'; ## DialogFooter +Footer section of the dialog + **Source:** [`packages/appkit-ui/src/react/ui/dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx) @@ -137,6 +146,8 @@ import { DialogFooter } from '@databricks/appkit-ui'; ## DialogHeader +Header section of the dialog + **Source:** [`packages/appkit-ui/src/react/ui/dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx) @@ -158,6 +169,8 @@ import { DialogHeader } from '@databricks/appkit-ui'; ## DialogOverlay +Dimmed overlay behind the dialog + **Source:** [`packages/appkit-ui/src/react/ui/dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx) @@ -182,6 +195,8 @@ import { DialogOverlay } from '@databricks/appkit-ui'; ## DialogPortal +Portal container for dialog content + **Source:** [`packages/appkit-ui/src/react/ui/dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx) @@ -206,6 +221,8 @@ import { DialogPortal } from '@databricks/appkit-ui'; ## DialogTitle +Title text for the dialog + **Source:** [`packages/appkit-ui/src/react/ui/dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx) @@ -229,6 +246,8 @@ import { DialogTitle } from '@databricks/appkit-ui'; ## DialogTrigger +Button that opens the dialog + **Source:** [`packages/appkit-ui/src/react/ui/dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx) diff --git a/docs/docs/api/appkit-ui/components/Drawer.mdx b/docs/docs/api/appkit-ui/components/Drawer.mdx index 00de824..f59af22 100644 --- a/docs/docs/api/appkit-ui/components/Drawer.mdx +++ b/docs/docs/api/appkit-ui/components/Drawer.mdx @@ -1,9 +1,8 @@ ---- -title: Drawer ---- - # Drawer +Draggable panel that slides in from screen edges + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Drawer +Draggable panel that slides in from screen edges + **Source:** [`packages/appkit-ui/src/react/ui/drawer.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx) @@ -63,6 +64,8 @@ import { Drawer } from '@databricks/appkit-ui'; ## DrawerClose +Button that closes the drawer + **Source:** [`packages/appkit-ui/src/react/ui/drawer.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx) @@ -86,6 +89,8 @@ import { DrawerClose } from '@databricks/appkit-ui'; ## DrawerContent +Main content area of the drawer + **Source:** [`packages/appkit-ui/src/react/ui/drawer.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx) @@ -116,6 +121,8 @@ import { DrawerContent } from '@databricks/appkit-ui'; ## DrawerDescription +Description text for the drawer + **Source:** [`packages/appkit-ui/src/react/ui/drawer.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx) @@ -139,6 +146,8 @@ import { DrawerDescription } from '@databricks/appkit-ui'; ## DrawerFooter +Footer section of the drawer + **Source:** [`packages/appkit-ui/src/react/ui/drawer.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx) @@ -160,6 +169,8 @@ import { DrawerFooter } from '@databricks/appkit-ui'; ## DrawerHeader +Header section of the drawer + **Source:** [`packages/appkit-ui/src/react/ui/drawer.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx) @@ -181,6 +192,8 @@ import { DrawerHeader } from '@databricks/appkit-ui'; ## DrawerOverlay +Dimmed overlay behind the drawer + **Source:** [`packages/appkit-ui/src/react/ui/drawer.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx) @@ -205,6 +218,8 @@ import { DrawerOverlay } from '@databricks/appkit-ui'; ## DrawerPortal +Portal container for drawer content + **Source:** [`packages/appkit-ui/src/react/ui/drawer.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx) @@ -229,6 +244,8 @@ import { DrawerPortal } from '@databricks/appkit-ui'; ## DrawerTitle +Title text for the drawer + **Source:** [`packages/appkit-ui/src/react/ui/drawer.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx) @@ -252,6 +269,8 @@ import { DrawerTitle } from '@databricks/appkit-ui'; ## DrawerTrigger +Button that opens the drawer + **Source:** [`packages/appkit-ui/src/react/ui/drawer.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx) diff --git a/docs/docs/api/appkit-ui/components/DropdownMenu.mdx b/docs/docs/api/appkit-ui/components/DropdownMenu.mdx index ff27f6b..f03cb71 100644 --- a/docs/docs/api/appkit-ui/components/DropdownMenu.mdx +++ b/docs/docs/api/appkit-ui/components/DropdownMenu.mdx @@ -1,9 +1,8 @@ ---- -title: DropdownMenu ---- - # DropdownMenu +Menu that displays when triggered by a button or element + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## DropdownMenu +Menu that displays when triggered by a button or element + **Source:** [`packages/appkit-ui/src/react/ui/dropdown-menu.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx) diff --git a/docs/docs/api/appkit-ui/components/Empty.mdx b/docs/docs/api/appkit-ui/components/Empty.mdx index 3ae447c..565d213 100644 --- a/docs/docs/api/appkit-ui/components/Empty.mdx +++ b/docs/docs/api/appkit-ui/components/Empty.mdx @@ -1,11 +1,12 @@ ---- -title: Empty ---- - # Empty +Empty state component for displaying no-data scenarios + + ## Empty +Empty state component for displaying no-data scenarios + **Source:** [`packages/appkit-ui/src/react/ui/empty.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/empty.tsx) diff --git a/docs/docs/api/appkit-ui/components/Field.mdx b/docs/docs/api/appkit-ui/components/Field.mdx index a072b8b..0e7992c 100644 --- a/docs/docs/api/appkit-ui/components/Field.mdx +++ b/docs/docs/api/appkit-ui/components/Field.mdx @@ -1,11 +1,12 @@ ---- -title: Field ---- - # Field +Form field wrapper with label and input positioning + + ## Field +Form field wrapper with label and input positioning + **Source:** [`packages/appkit-ui/src/react/ui/field.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx) @@ -29,6 +30,8 @@ import { Field } from '@databricks/appkit-ui'; ## FieldContent +Container for field label, description, and error messages + **Source:** [`packages/appkit-ui/src/react/ui/field.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx) @@ -50,6 +53,8 @@ import { FieldContent } from '@databricks/appkit-ui'; ## FieldDescription +Helper text providing additional context for a field + **Source:** [`packages/appkit-ui/src/react/ui/field.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx) @@ -71,6 +76,8 @@ import { FieldDescription } from '@databricks/appkit-ui'; ## FieldError +Error message display for invalid field values + **Source:** [`packages/appkit-ui/src/react/ui/field.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx) @@ -94,6 +101,8 @@ import { FieldError } from '@databricks/appkit-ui'; ## FieldGroup +Container for organizing multiple fields + **Source:** [`packages/appkit-ui/src/react/ui/field.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx) @@ -115,6 +124,8 @@ import { FieldGroup } from '@databricks/appkit-ui'; ## FieldLabel +Label for a form field + **Source:** [`packages/appkit-ui/src/react/ui/field.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx) @@ -138,6 +149,8 @@ import { FieldLabel } from '@databricks/appkit-ui'; ## FieldLegend +Title or caption for a fieldset + **Source:** [`packages/appkit-ui/src/react/ui/field.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx) @@ -161,6 +174,8 @@ import { FieldLegend } from '@databricks/appkit-ui'; ## FieldSeparator +Visual separator between fields with optional label + **Source:** [`packages/appkit-ui/src/react/ui/field.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx) @@ -182,6 +197,8 @@ import { FieldSeparator } from '@databricks/appkit-ui'; ## FieldSet +Container for grouping related form fields + **Source:** [`packages/appkit-ui/src/react/ui/field.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx) @@ -203,6 +220,8 @@ import { FieldSet } from '@databricks/appkit-ui'; ## FieldTitle +Title text for a field + **Source:** [`packages/appkit-ui/src/react/ui/field.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx) diff --git a/docs/docs/api/appkit-ui/components/Form.mdx b/docs/docs/api/appkit-ui/components/Form.mdx index 8c1654c..2120f3d 100644 --- a/docs/docs/api/appkit-ui/components/Form.mdx +++ b/docs/docs/api/appkit-ui/components/Form.mdx @@ -1,11 +1,12 @@ ---- -title: Form ---- - # Form +Wrapper for form control elements with accessibility attributes + + ## FormControl +Wrapper for form control elements with accessibility attributes + **Source:** [`packages/appkit-ui/src/react/ui/form.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx) @@ -27,6 +28,8 @@ import { FormControl } from '@databricks/appkit-ui'; ## FormDescription +Helper text providing guidance for a form field + **Source:** [`packages/appkit-ui/src/react/ui/form.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx) @@ -48,6 +51,8 @@ import { FormDescription } from '@databricks/appkit-ui'; ## FormField +Controlled field component for react-hook-form integration + **Source:** [`packages/appkit-ui/src/react/ui/form.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx) @@ -78,6 +83,8 @@ import { FormField } from '@databricks/appkit-ui'; ## FormItem +Container for a single form field with label and messages + **Source:** [`packages/appkit-ui/src/react/ui/form.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx) @@ -99,6 +106,8 @@ import { FormItem } from '@databricks/appkit-ui'; ## FormLabel +Label for a form field with error state styling + **Source:** [`packages/appkit-ui/src/react/ui/form.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx) @@ -122,6 +131,8 @@ import { FormLabel } from '@databricks/appkit-ui'; ## FormMessage +Validation error message for a form field + **Source:** [`packages/appkit-ui/src/react/ui/form.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx) diff --git a/docs/docs/api/appkit-ui/components/HoverCard.mdx b/docs/docs/api/appkit-ui/components/HoverCard.mdx index eacd69d..3802f5d 100644 --- a/docs/docs/api/appkit-ui/components/HoverCard.mdx +++ b/docs/docs/api/appkit-ui/components/HoverCard.mdx @@ -1,9 +1,8 @@ ---- -title: HoverCard ---- - # HoverCard +Content card that appears when hovering over an element + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## HoverCard +Content card that appears when hovering over an element + **Source:** [`packages/appkit-ui/src/react/ui/hover-card.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/hover-card.tsx) diff --git a/docs/docs/api/appkit-ui/components/Input.mdx b/docs/docs/api/appkit-ui/components/Input.mdx index ec8daa2..41c3a01 100644 --- a/docs/docs/api/appkit-ui/components/Input.mdx +++ b/docs/docs/api/appkit-ui/components/Input.mdx @@ -1,9 +1,8 @@ ---- -title: Input ---- - # Input +Text input field for single-line user input + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Input +Text input field for single-line user input + **Source:** [`packages/appkit-ui/src/react/ui/input.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input.tsx) diff --git a/docs/docs/api/appkit-ui/components/InputGroup.mdx b/docs/docs/api/appkit-ui/components/InputGroup.mdx index 0a60d02..c218f2c 100644 --- a/docs/docs/api/appkit-ui/components/InputGroup.mdx +++ b/docs/docs/api/appkit-ui/components/InputGroup.mdx @@ -1,11 +1,12 @@ ---- -title: InputGroup ---- - # InputGroup +Container for combining input fields with addons and buttons + + ## InputGroup +Container for combining input fields with addons and buttons + **Source:** [`packages/appkit-ui/src/react/ui/input-group.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-group.tsx) @@ -27,6 +28,8 @@ import { InputGroup } from '@databricks/appkit-ui'; ## InputGroupAddon +Decorative content positioned at the start or end of an input group + **Source:** [`packages/appkit-ui/src/react/ui/input-group.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-group.tsx) @@ -50,6 +53,8 @@ import { InputGroupAddon } from '@databricks/appkit-ui'; ## InputGroupButton +Button integrated within an input group + **Source:** [`packages/appkit-ui/src/react/ui/input-group.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-group.tsx) @@ -75,6 +80,8 @@ import { InputGroupButton } from '@databricks/appkit-ui'; ## InputGroupInput +Text input styled for use within an input group + **Source:** [`packages/appkit-ui/src/react/ui/input-group.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-group.tsx) @@ -96,6 +103,8 @@ import { InputGroupInput } from '@databricks/appkit-ui'; ## InputGroupText +Static text or icon displayed within an input group + **Source:** [`packages/appkit-ui/src/react/ui/input-group.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-group.tsx) @@ -117,6 +126,8 @@ import { InputGroupText } from '@databricks/appkit-ui'; ## InputGroupTextarea +Textarea styled for use within an input group + **Source:** [`packages/appkit-ui/src/react/ui/input-group.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-group.tsx) diff --git a/docs/docs/api/appkit-ui/components/InputOtp.mdx b/docs/docs/api/appkit-ui/components/InputOtp.mdx index 9808aa8..9342943 100644 --- a/docs/docs/api/appkit-ui/components/InputOtp.mdx +++ b/docs/docs/api/appkit-ui/components/InputOtp.mdx @@ -1,9 +1,8 @@ ---- -title: InputOtp ---- - # InputOtp +One-time password input with individual character slots + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## InputOTP +One-time password input with individual character slots + **Source:** [`packages/appkit-ui/src/react/ui/input-otp.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-otp.tsx) @@ -45,6 +46,8 @@ import { InputOTP } from '@databricks/appkit-ui'; ## InputOTPGroup +Container grouping OTP input slots together + **Source:** [`packages/appkit-ui/src/react/ui/input-otp.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-otp.tsx) @@ -66,6 +69,8 @@ import { InputOTPGroup } from '@databricks/appkit-ui'; ## InputOTPSeparator +Visual separator between OTP slot groups + **Source:** [`packages/appkit-ui/src/react/ui/input-otp.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-otp.tsx) @@ -87,6 +92,8 @@ import { InputOTPSeparator } from '@databricks/appkit-ui'; ## InputOTPSlot +Individual character slot within the OTP input + **Source:** [`packages/appkit-ui/src/react/ui/input-otp.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-otp.tsx) diff --git a/docs/docs/api/appkit-ui/components/Item.mdx b/docs/docs/api/appkit-ui/components/Item.mdx index 585ed14..87524a3 100644 --- a/docs/docs/api/appkit-ui/components/Item.mdx +++ b/docs/docs/api/appkit-ui/components/Item.mdx @@ -1,11 +1,12 @@ ---- -title: Item ---- - # Item +Flexible container for list items with media, content, and actions + + ## Item +Flexible container for list items with media, content, and actions + **Source:** [`packages/appkit-ui/src/react/ui/item.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/item.tsx) diff --git a/docs/docs/api/appkit-ui/components/Kbd.mdx b/docs/docs/api/appkit-ui/components/Kbd.mdx index ffbc696..2988638 100644 --- a/docs/docs/api/appkit-ui/components/Kbd.mdx +++ b/docs/docs/api/appkit-ui/components/Kbd.mdx @@ -1,11 +1,12 @@ ---- -title: Kbd ---- - # Kbd +Visual representation of keyboard keys + + ## Kbd +Visual representation of keyboard keys + **Source:** [`packages/appkit-ui/src/react/ui/kbd.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/kbd.tsx) diff --git a/docs/docs/api/appkit-ui/components/Label.mdx b/docs/docs/api/appkit-ui/components/Label.mdx index 42676dd..547a5a1 100644 --- a/docs/docs/api/appkit-ui/components/Label.mdx +++ b/docs/docs/api/appkit-ui/components/Label.mdx @@ -1,9 +1,8 @@ ---- -title: Label ---- - # Label +Text label associated with form controls + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Label +Text label associated with form controls + **Source:** [`packages/appkit-ui/src/react/ui/label.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/label.tsx) diff --git a/docs/docs/api/appkit-ui/components/Menubar.mdx b/docs/docs/api/appkit-ui/components/Menubar.mdx index 3ae25d7..30983aa 100644 --- a/docs/docs/api/appkit-ui/components/Menubar.mdx +++ b/docs/docs/api/appkit-ui/components/Menubar.mdx @@ -1,9 +1,8 @@ ---- -title: Menubar ---- - # Menubar +Horizontal menu bar with dropdown menus + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Menubar +Horizontal menu bar with dropdown menus + **Source:** [`packages/appkit-ui/src/react/ui/menubar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx) diff --git a/docs/docs/api/appkit-ui/components/NavigationMenu.mdx b/docs/docs/api/appkit-ui/components/NavigationMenu.mdx index fcd596f..997f36e 100644 --- a/docs/docs/api/appkit-ui/components/NavigationMenu.mdx +++ b/docs/docs/api/appkit-ui/components/NavigationMenu.mdx @@ -1,9 +1,8 @@ ---- -title: NavigationMenu ---- - # NavigationMenu +Horizontal navigation menu with dropdown submenus + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## NavigationMenu +Horizontal navigation menu with dropdown submenus + **Source:** [`packages/appkit-ui/src/react/ui/navigation-menu.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx) @@ -44,6 +45,8 @@ import { NavigationMenu } from '@databricks/appkit-ui'; ## NavigationMenuContent +Dropdown content area for navigation submenu + **Source:** [`packages/appkit-ui/src/react/ui/navigation-menu.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx) @@ -72,6 +75,8 @@ import { NavigationMenuContent } from '@databricks/appkit-ui'; ## NavigationMenuIndicator +Visual indicator for active navigation menu item + **Source:** [`packages/appkit-ui/src/react/ui/navigation-menu.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx) @@ -96,6 +101,8 @@ import { NavigationMenuIndicator } from '@databricks/appkit-ui'; ## NavigationMenuItem +Individual navigation menu item + **Source:** [`packages/appkit-ui/src/react/ui/navigation-menu.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx) @@ -120,6 +127,8 @@ import { NavigationMenuItem } from '@databricks/appkit-ui'; ## NavigationMenuLink +Clickable link within navigation menu + **Source:** [`packages/appkit-ui/src/react/ui/navigation-menu.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx) @@ -145,6 +154,8 @@ import { NavigationMenuLink } from '@databricks/appkit-ui'; ## NavigationMenuList +Container list for navigation menu items + **Source:** [`packages/appkit-ui/src/react/ui/navigation-menu.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx) @@ -168,6 +179,8 @@ import { NavigationMenuList } from '@databricks/appkit-ui'; ## NavigationMenuTrigger +Button that opens a navigation submenu + **Source:** [`packages/appkit-ui/src/react/ui/navigation-menu.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx) @@ -191,6 +204,8 @@ import { NavigationMenuTrigger } from '@databricks/appkit-ui'; ## NavigationMenuViewport +Viewport container for navigation menu content + **Source:** [`packages/appkit-ui/src/react/ui/navigation-menu.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx) diff --git a/docs/docs/api/appkit-ui/components/Pagination.mdx b/docs/docs/api/appkit-ui/components/Pagination.mdx index 1fb0e0a..1e930d7 100644 --- a/docs/docs/api/appkit-ui/components/Pagination.mdx +++ b/docs/docs/api/appkit-ui/components/Pagination.mdx @@ -1,9 +1,8 @@ ---- -title: Pagination ---- - # Pagination +Navigation component for paginated content + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Pagination +Navigation component for paginated content + **Source:** [`packages/appkit-ui/src/react/ui/pagination.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx) @@ -34,6 +35,8 @@ import { Pagination } from '@databricks/appkit-ui'; ## PaginationContent +Container for pagination items + **Source:** [`packages/appkit-ui/src/react/ui/pagination.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx) @@ -55,6 +58,8 @@ import { PaginationContent } from '@databricks/appkit-ui'; ## PaginationEllipsis +Ellipsis indicator for skipped page numbers + **Source:** [`packages/appkit-ui/src/react/ui/pagination.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx) @@ -76,6 +81,8 @@ import { PaginationEllipsis } from '@databricks/appkit-ui'; ## PaginationItem +Individual pagination item wrapper + **Source:** [`packages/appkit-ui/src/react/ui/pagination.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx) @@ -97,6 +104,8 @@ import { PaginationItem } from '@databricks/appkit-ui'; ## PaginationLink +Clickable link for navigating to a specific page + **Source:** [`packages/appkit-ui/src/react/ui/pagination.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx) @@ -121,6 +130,8 @@ import { PaginationLink } from '@databricks/appkit-ui'; ## PaginationNext +Button for navigating to the next page + **Source:** [`packages/appkit-ui/src/react/ui/pagination.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx) @@ -145,6 +156,8 @@ import { PaginationNext } from '@databricks/appkit-ui'; ## PaginationPrevious +Button for navigating to the previous page + **Source:** [`packages/appkit-ui/src/react/ui/pagination.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx) diff --git a/docs/docs/api/appkit-ui/components/Popover.mdx b/docs/docs/api/appkit-ui/components/Popover.mdx index a90b894..1aee198 100644 --- a/docs/docs/api/appkit-ui/components/Popover.mdx +++ b/docs/docs/api/appkit-ui/components/Popover.mdx @@ -1,9 +1,8 @@ ---- -title: Popover ---- - # Popover +Floating content panel anchored to a trigger element + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Popover +Floating content panel anchored to a trigger element + **Source:** [`packages/appkit-ui/src/react/ui/popover.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/popover.tsx) diff --git a/docs/docs/api/appkit-ui/components/Progress.mdx b/docs/docs/api/appkit-ui/components/Progress.mdx index b0398be..eaee62c 100644 --- a/docs/docs/api/appkit-ui/components/Progress.mdx +++ b/docs/docs/api/appkit-ui/components/Progress.mdx @@ -1,9 +1,8 @@ ---- -title: Progress ---- - # Progress +Visual indicator showing task completion percentage + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Progress +Visual indicator showing task completion percentage + **Source:** [`packages/appkit-ui/src/react/ui/progress.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/progress.tsx) diff --git a/docs/docs/api/appkit-ui/components/RadioGroup.mdx b/docs/docs/api/appkit-ui/components/RadioGroup.mdx index 84dceb2..8abb465 100644 --- a/docs/docs/api/appkit-ui/components/RadioGroup.mdx +++ b/docs/docs/api/appkit-ui/components/RadioGroup.mdx @@ -1,9 +1,8 @@ ---- -title: RadioGroup ---- - # RadioGroup +Group of radio buttons for selecting a single option + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## RadioGroup +Group of radio buttons for selecting a single option + **Source:** [`packages/appkit-ui/src/react/ui/radio-group.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/radio-group.tsx) diff --git a/docs/docs/api/appkit-ui/components/Resizable.mdx b/docs/docs/api/appkit-ui/components/Resizable.mdx index acd595c..eda0bbf 100644 --- a/docs/docs/api/appkit-ui/components/Resizable.mdx +++ b/docs/docs/api/appkit-ui/components/Resizable.mdx @@ -1,9 +1,8 @@ ---- -title: Resizable ---- - # Resizable +Draggable handle for resizing panels + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## ResizableHandle +Draggable handle for resizing panels + **Source:** [`packages/appkit-ui/src/react/ui/resizable.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/resizable.tsx) @@ -46,6 +47,8 @@ import { ResizableHandle } from '@databricks/appkit-ui'; ## ResizablePanel +Individual resizable panel within a panel group + **Source:** [`packages/appkit-ui/src/react/ui/resizable.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/resizable.tsx) @@ -79,6 +82,8 @@ import { ResizablePanel } from '@databricks/appkit-ui'; ## ResizablePanelGroup +Container for resizable panel layout + **Source:** [`packages/appkit-ui/src/react/ui/resizable.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/resizable.tsx) diff --git a/docs/docs/api/appkit-ui/components/ScrollArea.mdx b/docs/docs/api/appkit-ui/components/ScrollArea.mdx index c00a421..14fbcee 100644 --- a/docs/docs/api/appkit-ui/components/ScrollArea.mdx +++ b/docs/docs/api/appkit-ui/components/ScrollArea.mdx @@ -1,9 +1,8 @@ ---- -title: ScrollArea ---- - # ScrollArea +Container with custom scrollbars for overflow content + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## ScrollArea +Container with custom scrollbars for overflow content + **Source:** [`packages/appkit-ui/src/react/ui/scroll-area.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/scroll-area.tsx) @@ -39,6 +40,8 @@ import { ScrollArea } from '@databricks/appkit-ui'; ## ScrollBar +Scrollbar component for the scroll area + **Source:** [`packages/appkit-ui/src/react/ui/scroll-area.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/scroll-area.tsx) diff --git a/docs/docs/api/appkit-ui/components/Select.mdx b/docs/docs/api/appkit-ui/components/Select.mdx index 4bb187c..a68854f 100644 --- a/docs/docs/api/appkit-ui/components/Select.mdx +++ b/docs/docs/api/appkit-ui/components/Select.mdx @@ -1,9 +1,8 @@ ---- -title: Select ---- - # Select +Dropdown control for selecting a value from a list + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Select +Dropdown control for selecting a value from a list + **Source:** [`packages/appkit-ui/src/react/ui/select.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/select.tsx) diff --git a/docs/docs/api/appkit-ui/components/Separator.mdx b/docs/docs/api/appkit-ui/components/Separator.mdx index 24a2f19..fc94918 100644 --- a/docs/docs/api/appkit-ui/components/Separator.mdx +++ b/docs/docs/api/appkit-ui/components/Separator.mdx @@ -1,9 +1,8 @@ ---- -title: Separator ---- - # Separator +Visual divider line between content sections + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Separator +Visual divider line between content sections + **Source:** [`packages/appkit-ui/src/react/ui/separator.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/separator.tsx) diff --git a/docs/docs/api/appkit-ui/components/Sheet.mdx b/docs/docs/api/appkit-ui/components/Sheet.mdx index 28ca2a0..1a3d32b 100644 --- a/docs/docs/api/appkit-ui/components/Sheet.mdx +++ b/docs/docs/api/appkit-ui/components/Sheet.mdx @@ -1,9 +1,8 @@ ---- -title: Sheet ---- - # Sheet +Sliding panel that overlays content from screen edges + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Sheet +Sliding panel that overlays content from screen edges + **Source:** [`packages/appkit-ui/src/react/ui/sheet.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx) @@ -39,6 +40,8 @@ import { Sheet } from '@databricks/appkit-ui'; ## SheetClose +Button that closes the sheet + **Source:** [`packages/appkit-ui/src/react/ui/sheet.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx) @@ -62,6 +65,8 @@ import { SheetClose } from '@databricks/appkit-ui'; ## SheetContent +Main content area of the sheet + **Source:** [`packages/appkit-ui/src/react/ui/sheet.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx) @@ -93,6 +98,8 @@ import { SheetContent } from '@databricks/appkit-ui'; ## SheetDescription +Description text for the sheet + **Source:** [`packages/appkit-ui/src/react/ui/sheet.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx) @@ -116,6 +123,8 @@ import { SheetDescription } from '@databricks/appkit-ui'; ## SheetFooter +Footer section of the sheet + **Source:** [`packages/appkit-ui/src/react/ui/sheet.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx) @@ -137,6 +146,8 @@ import { SheetFooter } from '@databricks/appkit-ui'; ## SheetHeader +Header section of the sheet + **Source:** [`packages/appkit-ui/src/react/ui/sheet.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx) @@ -158,6 +169,8 @@ import { SheetHeader } from '@databricks/appkit-ui'; ## SheetTitle +Title text for the sheet + **Source:** [`packages/appkit-ui/src/react/ui/sheet.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx) @@ -181,6 +194,8 @@ import { SheetTitle } from '@databricks/appkit-ui'; ## SheetTrigger +Button that opens the sheet + **Source:** [`packages/appkit-ui/src/react/ui/sheet.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx) diff --git a/docs/docs/api/appkit-ui/components/Sidebar.mdx b/docs/docs/api/appkit-ui/components/Sidebar.mdx index f5f5306..df0ec1b 100644 --- a/docs/docs/api/appkit-ui/components/Sidebar.mdx +++ b/docs/docs/api/appkit-ui/components/Sidebar.mdx @@ -1,11 +1,12 @@ ---- -title: Sidebar ---- - # Sidebar +Collapsible navigation sidebar with mobile support + + ## Sidebar +Collapsible navigation sidebar with mobile support + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -31,6 +32,8 @@ import { Sidebar } from '@databricks/appkit-ui'; ## SidebarContent +Scrollable content area within the sidebar + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -52,6 +55,8 @@ import { SidebarContent } from '@databricks/appkit-ui'; ## SidebarFooter +Footer section at the bottom of the sidebar + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -73,6 +78,8 @@ import { SidebarFooter } from '@databricks/appkit-ui'; ## SidebarGroup +Container for grouping related sidebar items + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -94,6 +101,8 @@ import { SidebarGroup } from '@databricks/appkit-ui'; ## SidebarGroupAction +Action button displayed next to a sidebar group label + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -117,6 +126,8 @@ import { SidebarGroupAction } from '@databricks/appkit-ui'; ## SidebarGroupContent +Content container for sidebar group items + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -138,6 +149,8 @@ import { SidebarGroupContent } from '@databricks/appkit-ui'; ## SidebarGroupLabel +Label heading for a sidebar group + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -161,6 +174,8 @@ import { SidebarGroupLabel } from '@databricks/appkit-ui'; ## SidebarHeader +Header section at the top of the sidebar + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -182,6 +197,8 @@ import { SidebarHeader } from '@databricks/appkit-ui'; ## SidebarInput +Input field styled for use within the sidebar + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -203,6 +220,8 @@ import { SidebarInput } from '@databricks/appkit-ui'; ## SidebarInset +Main content area that adapts to sidebar state + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -224,6 +243,8 @@ import { SidebarInset } from '@databricks/appkit-ui'; ## SidebarMenu +Navigation menu list within the sidebar + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -245,6 +266,8 @@ import { SidebarMenu } from '@databricks/appkit-ui'; ## SidebarMenuAction +Action button displayed alongside a menu item + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -269,6 +292,8 @@ import { SidebarMenuAction } from '@databricks/appkit-ui'; ## SidebarMenuBadge +Badge for displaying counts or status on menu items + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -317,6 +342,8 @@ import { SidebarMenuButton } from '@databricks/appkit-ui'; ## SidebarMenuItem +Individual menu item within the sidebar + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -338,6 +365,8 @@ import { SidebarMenuItem } from '@databricks/appkit-ui'; ## SidebarMenuSkeleton +Loading skeleton placeholder for menu items + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -361,6 +390,8 @@ import { SidebarMenuSkeleton } from '@databricks/appkit-ui'; ## SidebarMenuSub +Submenu list for nested navigation items + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -382,6 +413,8 @@ import { SidebarMenuSub } from '@databricks/appkit-ui'; ## SidebarMenuSubButton +Button for submenu items + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -407,6 +440,8 @@ import { SidebarMenuSubButton } from '@databricks/appkit-ui'; ## SidebarMenuSubItem +Individual item within a sidebar submenu + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -453,6 +488,8 @@ import { SidebarProvider } from '@databricks/appkit-ui'; ## SidebarRail +Clickable rail element for toggling sidebar visibility + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -474,6 +511,8 @@ import { SidebarRail } from '@databricks/appkit-ui'; ## SidebarSeparator +Visual separator between sidebar sections + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -499,6 +538,8 @@ import { SidebarSeparator } from '@databricks/appkit-ui'; ## SidebarTrigger +Button that toggles the sidebar open and closed + **Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) @@ -521,3 +562,26 @@ import { SidebarTrigger } from '@databricks/appkit-ui'; ``` + +## useSidebar + +Hook to access sidebar state and controls + + +**Source:** [`packages/appkit-ui/src/react/ui/sidebar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx) + + +### Props + +This component extends standard HTML element attributes. + + + +### Usage + +```tsx +import { useSidebar } from '@databricks/appkit-ui'; + + +``` + diff --git a/docs/docs/api/appkit-ui/components/Skeleton.mdx b/docs/docs/api/appkit-ui/components/Skeleton.mdx index 9c396cf..abb7663 100644 --- a/docs/docs/api/appkit-ui/components/Skeleton.mdx +++ b/docs/docs/api/appkit-ui/components/Skeleton.mdx @@ -1,9 +1,8 @@ ---- -title: Skeleton ---- - # Skeleton +Loading placeholder with pulsing animation + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Skeleton +Loading placeholder with pulsing animation + **Source:** [`packages/appkit-ui/src/react/ui/skeleton.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/skeleton.tsx) diff --git a/docs/docs/api/appkit-ui/components/Slider.mdx b/docs/docs/api/appkit-ui/components/Slider.mdx index 19d72a6..424d32e 100644 --- a/docs/docs/api/appkit-ui/components/Slider.mdx +++ b/docs/docs/api/appkit-ui/components/Slider.mdx @@ -1,9 +1,8 @@ ---- -title: Slider ---- - # Slider +Draggable input for selecting numeric values within a range + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Slider +Draggable input for selecting numeric values within a range + **Source:** [`packages/appkit-ui/src/react/ui/slider.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/slider.tsx) diff --git a/docs/docs/api/appkit-ui/components/Sonner.mdx b/docs/docs/api/appkit-ui/components/Sonner.mdx index 6649d00..de0aa16 100644 --- a/docs/docs/api/appkit-ui/components/Sonner.mdx +++ b/docs/docs/api/appkit-ui/components/Sonner.mdx @@ -1,9 +1,8 @@ ---- -title: Sonner ---- - # Sonner +Toast notification system for displaying temporary messages + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Toaster +Toast notification system for displaying temporary messages + **Source:** [`packages/appkit-ui/src/react/ui/sonner.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sonner.tsx) diff --git a/docs/docs/api/appkit-ui/components/Spinner.mdx b/docs/docs/api/appkit-ui/components/Spinner.mdx index 91ae6ec..0078338 100644 --- a/docs/docs/api/appkit-ui/components/Spinner.mdx +++ b/docs/docs/api/appkit-ui/components/Spinner.mdx @@ -1,11 +1,12 @@ ---- -title: Spinner ---- - # Spinner +Animated loading indicator + + ## Spinner +Animated loading indicator + **Source:** [`packages/appkit-ui/src/react/ui/spinner.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/spinner.tsx) diff --git a/docs/docs/api/appkit-ui/components/Switch.mdx b/docs/docs/api/appkit-ui/components/Switch.mdx index d9d63e0..8fb8807 100644 --- a/docs/docs/api/appkit-ui/components/Switch.mdx +++ b/docs/docs/api/appkit-ui/components/Switch.mdx @@ -1,9 +1,8 @@ ---- -title: Switch ---- - # Switch +Toggle control for switching between on and off states + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Switch +Toggle control for switching between on and off states + **Source:** [`packages/appkit-ui/src/react/ui/switch.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/switch.tsx) diff --git a/docs/docs/api/appkit-ui/components/Table.mdx b/docs/docs/api/appkit-ui/components/Table.mdx index 51341dc..90b5c7d 100644 --- a/docs/docs/api/appkit-ui/components/Table.mdx +++ b/docs/docs/api/appkit-ui/components/Table.mdx @@ -1,9 +1,8 @@ ---- -title: Table ---- - # Table +Structured data display with rows and columns + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Table +Structured data display with rows and columns + **Source:** [`packages/appkit-ui/src/react/ui/table.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/table.tsx) diff --git a/docs/docs/api/appkit-ui/components/Tabs.mdx b/docs/docs/api/appkit-ui/components/Tabs.mdx index f0c1e87..dc18fca 100644 --- a/docs/docs/api/appkit-ui/components/Tabs.mdx +++ b/docs/docs/api/appkit-ui/components/Tabs.mdx @@ -1,9 +1,8 @@ ---- -title: Tabs ---- - # Tabs +Tabbed interface for organizing content into separate panels + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Tabs +Tabbed interface for organizing content into separate panels + **Source:** [`packages/appkit-ui/src/react/ui/tabs.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tabs.tsx) @@ -42,6 +43,8 @@ import { Tabs } from '@databricks/appkit-ui'; ## TabsContent +Content panel associated with a tab + **Source:** [`packages/appkit-ui/src/react/ui/tabs.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tabs.tsx) @@ -67,6 +70,8 @@ import { TabsContent } from '@databricks/appkit-ui'; ## TabsList +Container for tab trigger buttons + **Source:** [`packages/appkit-ui/src/react/ui/tabs.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tabs.tsx) @@ -91,6 +96,8 @@ import { TabsList } from '@databricks/appkit-ui'; ## TabsTrigger +Button that activates a tab panel + **Source:** [`packages/appkit-ui/src/react/ui/tabs.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tabs.tsx) diff --git a/docs/docs/api/appkit-ui/components/Textarea.mdx b/docs/docs/api/appkit-ui/components/Textarea.mdx index b4a7004..ed7c40c 100644 --- a/docs/docs/api/appkit-ui/components/Textarea.mdx +++ b/docs/docs/api/appkit-ui/components/Textarea.mdx @@ -1,9 +1,8 @@ ---- -title: Textarea ---- - # Textarea +Multi-line text input field + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Textarea +Multi-line text input field + **Source:** [`packages/appkit-ui/src/react/ui/textarea.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/textarea.tsx) diff --git a/docs/docs/api/appkit-ui/components/Toggle.mdx b/docs/docs/api/appkit-ui/components/Toggle.mdx index 8215c4d..45377ae 100644 --- a/docs/docs/api/appkit-ui/components/Toggle.mdx +++ b/docs/docs/api/appkit-ui/components/Toggle.mdx @@ -1,9 +1,8 @@ ---- -title: Toggle ---- - # Toggle +Button that toggles between pressed and unpressed states + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Toggle +Button that toggles between pressed and unpressed states + **Source:** [`packages/appkit-ui/src/react/ui/toggle.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/toggle.tsx) diff --git a/docs/docs/api/appkit-ui/components/ToggleGroup.mdx b/docs/docs/api/appkit-ui/components/ToggleGroup.mdx index e7a26ea..08fe028 100644 --- a/docs/docs/api/appkit-ui/components/ToggleGroup.mdx +++ b/docs/docs/api/appkit-ui/components/ToggleGroup.mdx @@ -1,9 +1,8 @@ ---- -title: ToggleGroup ---- - # ToggleGroup +Group of toggle buttons for selecting one or more options + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## ToggleGroup +Group of toggle buttons for selecting one or more options + **Source:** [`packages/appkit-ui/src/react/ui/toggle-group.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/toggle-group.tsx) diff --git a/docs/docs/api/appkit-ui/components/Tooltip.mdx b/docs/docs/api/appkit-ui/components/Tooltip.mdx index fddd8e3..94d609d 100644 --- a/docs/docs/api/appkit-ui/components/Tooltip.mdx +++ b/docs/docs/api/appkit-ui/components/Tooltip.mdx @@ -1,9 +1,8 @@ ---- -title: Tooltip ---- - # Tooltip +Brief informational message that appears on hover + + ## Example import { DocExample } from "@site/src/components/DocExample"; @@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample"; ## Tooltip +Brief informational message that appears on hover + **Source:** [`packages/appkit-ui/src/react/ui/tooltip.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tooltip.tsx) @@ -78,6 +79,8 @@ import { TooltipContent } from '@databricks/appkit-ui'; ## TooltipProvider +Context provider for tooltip configuration + **Source:** [`packages/appkit-ui/src/react/ui/tooltip.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tooltip.tsx) diff --git a/docs/docs/api/appkit/Class.Plugin.md b/docs/docs/api/appkit/Class.Plugin.md index 5e0c447..4908231 100644 --- a/docs/docs/api/appkit/Class.Plugin.md +++ b/docs/docs/api/appkit/Class.Plugin.md @@ -1,6 +1,6 @@ # Abstract Class: Plugin\ -Defined in: [appkit/src/plugin/plugin.ts:58](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L58) +Base abstract class for creating AppKit plugins ## Type Parameters @@ -20,8 +20,6 @@ Defined in: [appkit/src/plugin/plugin.ts:58](https://github.com/databricks/appki new Plugin(config: TConfig): Plugin; ``` -Defined in: [appkit/src/plugin/plugin.ts:76](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L76) - #### Parameters | Parameter | Type | @@ -40,8 +38,6 @@ Defined in: [appkit/src/plugin/plugin.ts:76](https://github.com/databricks/appki protected app: AppManager; ``` -Defined in: [appkit/src/plugin/plugin.ts:64](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L64) - *** ### cache @@ -50,8 +46,6 @@ Defined in: [appkit/src/plugin/plugin.ts:64](https://github.com/databricks/appki protected cache: CacheManager; ``` -Defined in: [appkit/src/plugin/plugin.ts:63](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L63) - *** ### config @@ -60,8 +54,6 @@ Defined in: [appkit/src/plugin/plugin.ts:63](https://github.com/databricks/appki protected config: TConfig; ``` -Defined in: [appkit/src/plugin/plugin.ts:76](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L76) - *** ### devFileReader @@ -70,8 +62,6 @@ Defined in: [appkit/src/plugin/plugin.ts:76](https://github.com/databricks/appki protected devFileReader: DevFileReader; ``` -Defined in: [appkit/src/plugin/plugin.ts:65](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L65) - *** ### envVars @@ -80,8 +70,6 @@ Defined in: [appkit/src/plugin/plugin.ts:65](https://github.com/databricks/appki abstract protected envVars: string[]; ``` -Defined in: [appkit/src/plugin/plugin.ts:68](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L68) - *** ### isReady @@ -90,8 +78,6 @@ Defined in: [appkit/src/plugin/plugin.ts:68](https://github.com/databricks/appki protected isReady: boolean = false; ``` -Defined in: [appkit/src/plugin/plugin.ts:62](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L62) - *** ### name @@ -100,8 +86,6 @@ Defined in: [appkit/src/plugin/plugin.ts:62](https://github.com/databricks/appki name: string; ``` -Defined in: [appkit/src/plugin/plugin.ts:74](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L74) - #### Implementation of ```ts @@ -116,8 +100,6 @@ BasePlugin.name protected streamManager: StreamManager; ``` -Defined in: [appkit/src/plugin/plugin.ts:66](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L66) - *** ### telemetry @@ -126,8 +108,6 @@ Defined in: [appkit/src/plugin/plugin.ts:66](https://github.com/databricks/appki protected telemetry: ITelemetry; ``` -Defined in: [appkit/src/plugin/plugin.ts:67](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L67) - *** ### phase @@ -136,8 +116,6 @@ Defined in: [appkit/src/plugin/plugin.ts:67](https://github.com/databricks/appki static phase: PluginPhase = "normal"; ``` -Defined in: [appkit/src/plugin/plugin.ts:73](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L73) - ## Methods ### abortActiveOperations() @@ -146,8 +124,6 @@ Defined in: [appkit/src/plugin/plugin.ts:73](https://github.com/databricks/appki abortActiveOperations(): void; ``` -Defined in: [appkit/src/plugin/plugin.ts:101](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L101) - #### Returns `void` @@ -166,8 +142,6 @@ BasePlugin.abortActiveOperations asUser(req: Request): this; ``` -Defined in: [appkit/src/plugin/plugin.ts:134](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L134) - Execute operations using the user's identity from the request. Returns a scoped instance of this plugin where all method calls @@ -220,8 +194,6 @@ protected execute( userKey?: string): Promise; ``` -Defined in: [appkit/src/plugin/plugin.ts:263](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L263) - #### Type Parameters | Type Parameter | @@ -252,8 +224,6 @@ protected executeStream( userKey?: string): Promise; ``` -Defined in: [appkit/src/plugin/plugin.ts:201](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L201) - #### Type Parameters | Type Parameter | @@ -281,8 +251,6 @@ Defined in: [appkit/src/plugin/plugin.ts:201](https://github.com/databricks/appk getEndpoints(): PluginEndpointMap; ``` -Defined in: [appkit/src/plugin/plugin.ts:97](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L97) - #### Returns `PluginEndpointMap` @@ -301,8 +269,6 @@ BasePlugin.getEndpoints injectRoutes(_: Router): void; ``` -Defined in: [appkit/src/plugin/plugin.ts:91](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L91) - #### Parameters | Parameter | Type | @@ -327,8 +293,6 @@ BasePlugin.injectRoutes protected registerEndpoint(name: string, path: string): void; ``` -Defined in: [appkit/src/plugin/plugin.ts:288](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L288) - #### Parameters | Parameter | Type | @@ -348,8 +312,6 @@ Defined in: [appkit/src/plugin/plugin.ts:288](https://github.com/databricks/appk protected route<_TResponse>(router: Router, config: RouteConfig): void; ``` -Defined in: [appkit/src/plugin/plugin.ts:292](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L292) - #### Type Parameters | Type Parameter | @@ -375,8 +337,6 @@ Defined in: [appkit/src/plugin/plugin.ts:292](https://github.com/databricks/appk setup(): Promise; ``` -Defined in: [appkit/src/plugin/plugin.ts:95](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L95) - #### Returns `Promise`\<`void`\> @@ -395,8 +355,6 @@ BasePlugin.setup validateEnv(): void; ``` -Defined in: [appkit/src/plugin/plugin.ts:87](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L87) - #### Returns `void` diff --git a/docs/docs/api/appkit/Function.appKitTypesPlugin.md b/docs/docs/api/appkit/Function.appKitTypesPlugin.md index 9cbd64c..9750c26 100644 --- a/docs/docs/api/appkit/Function.appKitTypesPlugin.md +++ b/docs/docs/api/appkit/Function.appKitTypesPlugin.md @@ -4,8 +4,6 @@ function appKitTypesPlugin(options?: AppKitTypesPluginOptions): Plugin$1; ``` -Defined in: [appkit/src/type-generator/vite-plugin.ts:22](https://github.com/databricks/appkit/blob/main/packages/appkit/src/type-generator/vite-plugin.ts#L22) - Vite plugin to generate types for AppKit queries. Calls generateFromEntryPoint under the hood. diff --git a/docs/docs/api/appkit/Function.createApp.md b/docs/docs/api/appkit/Function.createApp.md index 63c630b..35128e0 100644 --- a/docs/docs/api/appkit/Function.createApp.md +++ b/docs/docs/api/appkit/Function.createApp.md @@ -8,8 +8,6 @@ function createApp(config: { }): Promise>; ``` -Defined in: [appkit/src/core/appkit.ts:133](https://github.com/databricks/appkit/blob/main/packages/appkit/src/core/appkit.ts#L133) - Bootstraps AppKit with the provided configuration. ## Type Parameters diff --git a/docs/docs/api/appkit/Function.isSQLTypeMarker.md b/docs/docs/api/appkit/Function.isSQLTypeMarker.md index 08852d9..f74ba05 100644 --- a/docs/docs/api/appkit/Function.isSQLTypeMarker.md +++ b/docs/docs/api/appkit/Function.isSQLTypeMarker.md @@ -4,8 +4,6 @@ function isSQLTypeMarker(value: any): value is SQLTypeMarker; ``` -Defined in: [shared/src/sql/helpers.ts:344](https://github.com/databricks/appkit/blob/main/packages/shared/src/sql/helpers.ts#L344) - Type guard to check if a value is a SQL type marker ## Parameters diff --git a/docs/docs/api/appkit/Interface.BasePluginConfig.md b/docs/docs/api/appkit/Interface.BasePluginConfig.md index d47a75c..a7faffc 100644 --- a/docs/docs/api/appkit/Interface.BasePluginConfig.md +++ b/docs/docs/api/appkit/Interface.BasePluginConfig.md @@ -1,6 +1,6 @@ # Interface: BasePluginConfig -Defined in: [shared/src/plugin.ts:17](https://github.com/databricks/appkit/blob/main/packages/shared/src/plugin.ts#L17) +Base configuration interface for AppKit plugins ## Indexable @@ -16,8 +16,6 @@ Defined in: [shared/src/plugin.ts:17](https://github.com/databricks/appkit/blob/ optional host: string; ``` -Defined in: [shared/src/plugin.ts:19](https://github.com/databricks/appkit/blob/main/packages/shared/src/plugin.ts#L19) - *** ### name? @@ -26,8 +24,6 @@ Defined in: [shared/src/plugin.ts:19](https://github.com/databricks/appkit/blob/ optional name: string; ``` -Defined in: [shared/src/plugin.ts:18](https://github.com/databricks/appkit/blob/main/packages/shared/src/plugin.ts#L18) - *** ### telemetry? @@ -35,5 +31,3 @@ Defined in: [shared/src/plugin.ts:18](https://github.com/databricks/appkit/blob/ ```ts optional telemetry: TelemetryOptions; ``` - -Defined in: [shared/src/plugin.ts:27](https://github.com/databricks/appkit/blob/main/packages/shared/src/plugin.ts#L27) diff --git a/docs/docs/api/appkit/Interface.CacheConfig.md b/docs/docs/api/appkit/Interface.CacheConfig.md index d1d26dd..e1a62e2 100644 --- a/docs/docs/api/appkit/Interface.CacheConfig.md +++ b/docs/docs/api/appkit/Interface.CacheConfig.md @@ -1,7 +1,5 @@ # Interface: CacheConfig -Defined in: [shared/src/cache.ts:36](https://github.com/databricks/appkit/blob/main/packages/shared/src/cache.ts#L36) - Configuration for caching ## Indexable @@ -18,8 +16,6 @@ Configuration for caching optional cacheKey: (string | number | object)[]; ``` -Defined in: [shared/src/cache.ts:46](https://github.com/databricks/appkit/blob/main/packages/shared/src/cache.ts#L46) - Cache key *** @@ -30,8 +26,6 @@ Cache key optional cleanupProbability: number; ``` -Defined in: [shared/src/cache.ts:55](https://github.com/databricks/appkit/blob/main/packages/shared/src/cache.ts#L55) - Probability (0-1) of triggering cleanup on each get operation *** @@ -42,8 +36,6 @@ Probability (0-1) of triggering cleanup on each get operation optional enabled: boolean; ``` -Defined in: [shared/src/cache.ts:38](https://github.com/databricks/appkit/blob/main/packages/shared/src/cache.ts#L38) - Whether caching is enabled *** @@ -54,8 +46,6 @@ Whether caching is enabled optional evictionCheckProbability: number; ``` -Defined in: [shared/src/cache.ts:58](https://github.com/databricks/appkit/blob/main/packages/shared/src/cache.ts#L58) - Probability (0-1) of checking total bytes on each write operation *** @@ -66,8 +56,6 @@ Probability (0-1) of checking total bytes on each write operation optional maxBytes: number; ``` -Defined in: [shared/src/cache.ts:42](https://github.com/databricks/appkit/blob/main/packages/shared/src/cache.ts#L42) - Maximum number of bytes in the cache *** @@ -78,8 +66,6 @@ Maximum number of bytes in the cache optional maxEntryBytes: number; ``` -Defined in: [shared/src/cache.ts:61](https://github.com/databricks/appkit/blob/main/packages/shared/src/cache.ts#L61) - Maximum number of bytes per entry in the cache *** @@ -90,8 +76,6 @@ Maximum number of bytes per entry in the cache optional maxSize: number; ``` -Defined in: [shared/src/cache.ts:44](https://github.com/databricks/appkit/blob/main/packages/shared/src/cache.ts#L44) - Maximum number of entries in the cache *** @@ -102,8 +86,6 @@ Maximum number of entries in the cache optional storage: CacheStorage; ``` -Defined in: [shared/src/cache.ts:48](https://github.com/databricks/appkit/blob/main/packages/shared/src/cache.ts#L48) - Cache Storage provider instance *** @@ -114,8 +96,6 @@ Cache Storage provider instance optional strictPersistence: boolean; ``` -Defined in: [shared/src/cache.ts:50](https://github.com/databricks/appkit/blob/main/packages/shared/src/cache.ts#L50) - Whether to enforce strict persistence *** @@ -126,8 +106,6 @@ Whether to enforce strict persistence optional telemetry: TelemetryOptions; ``` -Defined in: [shared/src/cache.ts:52](https://github.com/databricks/appkit/blob/main/packages/shared/src/cache.ts#L52) - Telemetry configuration *** @@ -138,6 +116,4 @@ Telemetry configuration optional ttl: number; ``` -Defined in: [shared/src/cache.ts:40](https://github.com/databricks/appkit/blob/main/packages/shared/src/cache.ts#L40) - Time to live in seconds diff --git a/docs/docs/api/appkit/Interface.ITelemetry.md b/docs/docs/api/appkit/Interface.ITelemetry.md index 0478778..fc93138 100644 --- a/docs/docs/api/appkit/Interface.ITelemetry.md +++ b/docs/docs/api/appkit/Interface.ITelemetry.md @@ -1,7 +1,5 @@ # Interface: ITelemetry -Defined in: [appkit/src/telemetry/types.ts:33](https://github.com/databricks/appkit/blob/main/packages/appkit/src/telemetry/types.ts#L33) - Plugin-facing interface for OpenTelemetry instrumentation. Provides a thin abstraction over OpenTelemetry APIs for plugins. @@ -13,8 +11,6 @@ Provides a thin abstraction over OpenTelemetry APIs for plugins. emit(logRecord: LogRecord): void; ``` -Defined in: [appkit/src/telemetry/types.ts:57](https://github.com/databricks/appkit/blob/main/packages/appkit/src/telemetry/types.ts#L57) - Emits a log record using the default logger. Respects the logs enabled/disabled config. @@ -36,8 +32,6 @@ Respects the logs enabled/disabled config. getLogger(options?: InstrumentConfig): Logger; ``` -Defined in: [appkit/src/telemetry/types.ts:50](https://github.com/databricks/appkit/blob/main/packages/appkit/src/telemetry/types.ts#L50) - Gets a logger for emitting log records. #### Parameters @@ -58,8 +52,6 @@ Gets a logger for emitting log records. getMeter(options?: InstrumentConfig): Meter; ``` -Defined in: [appkit/src/telemetry/types.ts:44](https://github.com/databricks/appkit/blob/main/packages/appkit/src/telemetry/types.ts#L44) - Gets a meter for recording metrics. #### Parameters @@ -80,8 +72,6 @@ Gets a meter for recording metrics. getTracer(options?: InstrumentConfig): Tracer; ``` -Defined in: [appkit/src/telemetry/types.ts:38](https://github.com/databricks/appkit/blob/main/packages/appkit/src/telemetry/types.ts#L38) - Gets a tracer for creating spans. #### Parameters @@ -102,8 +92,6 @@ Gets a tracer for creating spans. registerInstrumentations(instrumentations: Instrumentation[]): void; ``` -Defined in: [appkit/src/telemetry/types.ts:81](https://github.com/databricks/appkit/blob/main/packages/appkit/src/telemetry/types.ts#L81) - Register OpenTelemetry instrumentations. Can be called at any time, but recommended to call in plugin constructor. @@ -129,8 +117,6 @@ startActiveSpan( tracerOptions?: InstrumentConfig): Promise; ``` -Defined in: [appkit/src/telemetry/types.ts:69](https://github.com/databricks/appkit/blob/main/packages/appkit/src/telemetry/types.ts#L69) - Starts an active span and executes a callback function within its context. Respects the traces enabled/disabled config. When traces are disabled, executes the callback with a no-op span. diff --git a/docs/docs/api/appkit/Interface.StreamExecutionSettings.md b/docs/docs/api/appkit/Interface.StreamExecutionSettings.md index 34d3569..dedcdd0 100644 --- a/docs/docs/api/appkit/Interface.StreamExecutionSettings.md +++ b/docs/docs/api/appkit/Interface.StreamExecutionSettings.md @@ -1,6 +1,6 @@ # Interface: StreamExecutionSettings -Defined in: [shared/src/execute.ts:48](https://github.com/databricks/appkit/blob/main/packages/shared/src/execute.ts#L48) +Configuration for streaming execution with default and user-scoped settings ## Properties @@ -10,8 +10,6 @@ Defined in: [shared/src/execute.ts:48](https://github.com/databricks/appkit/blob default: PluginExecuteConfig; ``` -Defined in: [shared/src/execute.ts:49](https://github.com/databricks/appkit/blob/main/packages/shared/src/execute.ts#L49) - *** ### stream? @@ -20,8 +18,6 @@ Defined in: [shared/src/execute.ts:49](https://github.com/databricks/appkit/blob optional stream: StreamConfig; ``` -Defined in: [shared/src/execute.ts:51](https://github.com/databricks/appkit/blob/main/packages/shared/src/execute.ts#L51) - *** ### user? @@ -29,5 +25,3 @@ Defined in: [shared/src/execute.ts:51](https://github.com/databricks/appkit/blob ```ts optional user: PluginExecuteConfig; ``` - -Defined in: [shared/src/execute.ts:50](https://github.com/databricks/appkit/blob/main/packages/shared/src/execute.ts#L50) diff --git a/docs/docs/api/appkit/Interface.TelemetryConfig.md b/docs/docs/api/appkit/Interface.TelemetryConfig.md index 89b03fa..132d840 100644 --- a/docs/docs/api/appkit/Interface.TelemetryConfig.md +++ b/docs/docs/api/appkit/Interface.TelemetryConfig.md @@ -1,6 +1,6 @@ # Interface: TelemetryConfig -Defined in: [appkit/src/telemetry/types.ts:5](https://github.com/databricks/appkit/blob/main/packages/appkit/src/telemetry/types.ts#L5) +OpenTelemetry configuration for AppKit applications ## Properties @@ -10,8 +10,6 @@ Defined in: [appkit/src/telemetry/types.ts:5](https://github.com/databricks/appk optional exportIntervalMs: number; ``` -Defined in: [appkit/src/telemetry/types.ts:9](https://github.com/databricks/appkit/blob/main/packages/appkit/src/telemetry/types.ts#L9) - *** ### headers? @@ -20,8 +18,6 @@ Defined in: [appkit/src/telemetry/types.ts:9](https://github.com/databricks/appk optional headers: Record; ``` -Defined in: [appkit/src/telemetry/types.ts:10](https://github.com/databricks/appkit/blob/main/packages/appkit/src/telemetry/types.ts#L10) - *** ### instrumentations? @@ -30,8 +26,6 @@ Defined in: [appkit/src/telemetry/types.ts:10](https://github.com/databricks/app optional instrumentations: Instrumentation[]; ``` -Defined in: [appkit/src/telemetry/types.ts:8](https://github.com/databricks/appkit/blob/main/packages/appkit/src/telemetry/types.ts#L8) - *** ### serviceName? @@ -40,8 +34,6 @@ Defined in: [appkit/src/telemetry/types.ts:8](https://github.com/databricks/appk optional serviceName: string; ``` -Defined in: [appkit/src/telemetry/types.ts:6](https://github.com/databricks/appkit/blob/main/packages/appkit/src/telemetry/types.ts#L6) - *** ### serviceVersion? @@ -49,5 +41,3 @@ Defined in: [appkit/src/telemetry/types.ts:6](https://github.com/databricks/appk ```ts optional serviceVersion: string; ``` - -Defined in: [appkit/src/telemetry/types.ts:7](https://github.com/databricks/appkit/blob/main/packages/appkit/src/telemetry/types.ts#L7) diff --git a/docs/docs/api/appkit/TypeAlias.IAppRouter.md b/docs/docs/api/appkit/TypeAlias.IAppRouter.md index 08197ba..f458327 100644 --- a/docs/docs/api/appkit/TypeAlias.IAppRouter.md +++ b/docs/docs/api/appkit/TypeAlias.IAppRouter.md @@ -4,4 +4,4 @@ type IAppRouter = express.Router; ``` -Defined in: [shared/src/plugin.ts:94](https://github.com/databricks/appkit/blob/main/packages/shared/src/plugin.ts#L94) +Express router type for plugin route registration diff --git a/docs/docs/api/appkit/Variable.sql.md b/docs/docs/api/appkit/Variable.sql.md index 8fc3e99..1b42dcd 100644 --- a/docs/docs/api/appkit/Variable.sql.md +++ b/docs/docs/api/appkit/Variable.sql.md @@ -11,8 +11,6 @@ const sql: { }; ``` -Defined in: [shared/src/sql/helpers.ts:14](https://github.com/databricks/appkit/blob/main/packages/shared/src/sql/helpers.ts#L14) - SQL helper namespace ## Type Declaration diff --git a/docs/docs/api/appkit/index.md b/docs/docs/api/appkit/index.md index 415735d..6b09eb2 100644 --- a/docs/docs/api/appkit/index.md +++ b/docs/docs/api/appkit/index.md @@ -1,26 +1,29 @@ # @databricks/appkit +Core library for building Databricks applications with type-safe SQL queries, +plugin architecture, and React integration. + ## Classes | Class | Description | | ------ | ------ | -| [Plugin](Class.Plugin.md) | - | +| [Plugin](Class.Plugin.md) | Base abstract class for creating AppKit plugins | ## Interfaces | Interface | Description | | ------ | ------ | -| [BasePluginConfig](Interface.BasePluginConfig.md) | - | +| [BasePluginConfig](Interface.BasePluginConfig.md) | Base configuration interface for AppKit plugins | | [CacheConfig](Interface.CacheConfig.md) | Configuration for caching | | [ITelemetry](Interface.ITelemetry.md) | Plugin-facing interface for OpenTelemetry instrumentation. Provides a thin abstraction over OpenTelemetry APIs for plugins. | -| [StreamExecutionSettings](Interface.StreamExecutionSettings.md) | - | -| [TelemetryConfig](Interface.TelemetryConfig.md) | - | +| [StreamExecutionSettings](Interface.StreamExecutionSettings.md) | Configuration for streaming execution with default and user-scoped settings | +| [TelemetryConfig](Interface.TelemetryConfig.md) | OpenTelemetry configuration for AppKit applications | ## Type Aliases | Type Alias | Description | | ------ | ------ | -| [IAppRouter](TypeAlias.IAppRouter.md) | - | +| [IAppRouter](TypeAlias.IAppRouter.md) | Express router type for plugin route registration | ## Variables @@ -34,4 +37,5 @@ | ------ | ------ | | [appKitTypesPlugin](Function.appKitTypesPlugin.md) | Vite plugin to generate types for AppKit queries. Calls generateFromEntryPoint under the hood. | | [createApp](Function.createApp.md) | Bootstraps AppKit with the provided configuration. | +| [generateFromEntryPoint](Function.generateFromEntryPoint.md) | Entry point for generating type declarations from all imported files | | [isSQLTypeMarker](Function.isSQLTypeMarker.md) | Type guard to check if a value is a SQL type marker | diff --git a/docs/docs/api/appkit/typedoc-sidebar.ts b/docs/docs/api/appkit/typedoc-sidebar.ts index 1b4302f..a2735cf 100644 --- a/docs/docs/api/appkit/typedoc-sidebar.ts +++ b/docs/docs/api/appkit/typedoc-sidebar.ts @@ -79,6 +79,11 @@ const typedocSidebar: SidebarsConfig = { id: "api/appkit/Function.createApp", label: "createApp" }, + { + type: "doc", + id: "api/appkit/Function.generateFromEntryPoint", + label: "generateFromEntryPoint" + }, { type: "doc", id: "api/appkit/Function.isSQLTypeMarker", diff --git a/docs/docs/index.md b/docs/docs/index.md index b684f68..3011f14 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -4,6 +4,8 @@ sidebar_position: 1 # Getting started +Learn how to get started with AppKit. + import Prerequisites from './_prerequisites.mdx'; ## Introduction diff --git a/packages/appkit-ui/src/react/ui/accordion.tsx b/packages/appkit-ui/src/react/ui/accordion.tsx index 771b9d4..48029eb 100644 --- a/packages/appkit-ui/src/react/ui/accordion.tsx +++ b/packages/appkit-ui/src/react/ui/accordion.tsx @@ -4,12 +4,14 @@ import { ChevronDownIcon } from "lucide-react"; import { cn } from "../lib/utils"; +/** Collapsible content sections organized in a vertical stack */ function Accordion({ ...props }: React.ComponentProps) { return ; } +/** Individual collapsible section within an accordion */ function AccordionItem({ className, ...props @@ -23,6 +25,7 @@ function AccordionItem({ ); } +/** Clickable button that triggers accordion content visibility */ function AccordionTrigger({ className, children, @@ -45,6 +48,7 @@ function AccordionTrigger({ ); } +/** Content area that expands and collapses within an accordion item */ function AccordionContent({ className, children, diff --git a/packages/appkit-ui/src/react/ui/alert-dialog.tsx b/packages/appkit-ui/src/react/ui/alert-dialog.tsx index a0286d6..f993123 100644 --- a/packages/appkit-ui/src/react/ui/alert-dialog.tsx +++ b/packages/appkit-ui/src/react/ui/alert-dialog.tsx @@ -5,12 +5,14 @@ import { cn } from "../lib/utils"; import { useResolvedPortalContainer } from "../portal-container-context"; import { buttonVariants } from "./button"; +/** Modal dialog that interrupts the user with critical information requiring immediate action */ function AlertDialog({ ...props }: React.ComponentProps) { return ; } +/** Button that triggers the alert dialog to open */ function AlertDialogTrigger({ ...props }: React.ComponentProps) { @@ -19,6 +21,7 @@ function AlertDialogTrigger({ ); } +/** Portal container for rendering alert dialog content outside the DOM hierarchy */ function AlertDialogPortal({ container, ...props @@ -32,6 +35,7 @@ function AlertDialogPortal({ ); } +/** Background overlay that dims content behind the alert dialog */ function AlertDialogOverlay({ className, ...props @@ -48,6 +52,7 @@ function AlertDialogOverlay({ ); } +/** Main content container for the alert dialog */ function AlertDialogContent({ className, ...props @@ -67,6 +72,7 @@ function AlertDialogContent({ ); } +/** Header section containing title and description */ function AlertDialogHeader({ className, ...props @@ -80,6 +86,7 @@ function AlertDialogHeader({ ); } +/** Footer section containing action buttons */ function AlertDialogFooter({ className, ...props @@ -96,6 +103,7 @@ function AlertDialogFooter({ ); } +/** Title heading for the alert dialog */ function AlertDialogTitle({ className, ...props @@ -109,6 +117,7 @@ function AlertDialogTitle({ ); } +/** Descriptive text explaining the alert */ function AlertDialogDescription({ className, ...props @@ -122,6 +131,7 @@ function AlertDialogDescription({ ); } +/** Primary action button that confirms the alert */ function AlertDialogAction({ className, ...props @@ -134,6 +144,7 @@ function AlertDialogAction({ ); } +/** Cancel button that dismisses the alert dialog */ function AlertDialogCancel({ className, ...props diff --git a/packages/appkit-ui/src/react/ui/alert.tsx b/packages/appkit-ui/src/react/ui/alert.tsx index 465767e..6b067c0 100644 --- a/packages/appkit-ui/src/react/ui/alert.tsx +++ b/packages/appkit-ui/src/react/ui/alert.tsx @@ -19,6 +19,7 @@ const alertVariants = cva( }, ); +/** Displays important information with optional icon and multiple variants */ function Alert({ className, variant, @@ -34,6 +35,7 @@ function Alert({ ); } +/** Title text for an alert component */ function AlertTitle({ className, ...props }: React.ComponentProps<"div">) { return (
) { ); } +/** Descriptive text content for an alert component */ function AlertDescription({ className, ...props diff --git a/packages/appkit-ui/src/react/ui/aspect-ratio.tsx b/packages/appkit-ui/src/react/ui/aspect-ratio.tsx index c16d6bc..c707a1a 100644 --- a/packages/appkit-ui/src/react/ui/aspect-ratio.tsx +++ b/packages/appkit-ui/src/react/ui/aspect-ratio.tsx @@ -2,6 +2,7 @@ import * as AspectRatioPrimitive from "@radix-ui/react-aspect-ratio"; +/** Container that maintains a specific aspect ratio for its content */ function AspectRatio({ ...props }: React.ComponentProps) { diff --git a/packages/appkit-ui/src/react/ui/avatar.tsx b/packages/appkit-ui/src/react/ui/avatar.tsx index 7a5e11b..a53b9aa 100644 --- a/packages/appkit-ui/src/react/ui/avatar.tsx +++ b/packages/appkit-ui/src/react/ui/avatar.tsx @@ -3,6 +3,7 @@ import * as AvatarPrimitive from "@radix-ui/react-avatar"; import { cn } from "../lib/utils"; +/** Displays user profile picture or initials in a circular container */ function Avatar({ className, ...props @@ -19,6 +20,7 @@ function Avatar({ ); } +/** Image element for the avatar */ function AvatarImage({ className, ...props @@ -32,6 +34,7 @@ function AvatarImage({ ); } +/** Fallback content displayed when avatar image fails to load */ function AvatarFallback({ className, ...props diff --git a/packages/appkit-ui/src/react/ui/badge.tsx b/packages/appkit-ui/src/react/ui/badge.tsx index 6788fe7..438e934 100644 --- a/packages/appkit-ui/src/react/ui/badge.tsx +++ b/packages/appkit-ui/src/react/ui/badge.tsx @@ -25,6 +25,7 @@ const badgeVariants = cva( }, ); +/** Small label for displaying status, categories, or counts */ function Badge({ className, variant, diff --git a/packages/appkit-ui/src/react/ui/breadcrumb.tsx b/packages/appkit-ui/src/react/ui/breadcrumb.tsx index fb17267..d1c2b01 100644 --- a/packages/appkit-ui/src/react/ui/breadcrumb.tsx +++ b/packages/appkit-ui/src/react/ui/breadcrumb.tsx @@ -4,10 +4,12 @@ import { ChevronRight, MoreHorizontal } from "lucide-react"; import { cn } from "../lib/utils"; +/** Navigation component showing the current page's location in the site hierarchy */ function Breadcrumb({ ...props }: React.ComponentProps<"nav">) { return