diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4bb789d..a191351 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -31,6 +31,7 @@ jobs: filters: | docs: - 'docs/**' + - 'packages/**' appkit: - '!docs/**' @@ -97,4 +98,23 @@ jobs: run: pnpm install --frozen-lockfile - name: Build Docs run: pnpm run docs:build + - name: Lint Generated Docs + run: pnpm run docs:lint + - name: Format Generated Docs + run: pnpm run docs:format + - name: Check for uncommitted docs changes + run: | + if ! git diff --exit-code docs/docs/api/; then + echo "❌ Error: Generated docs are out of sync with the codebase." + echo "" + echo "The API documentation in docs/docs/api/ has changes after running docs:generate." + echo "This means the committed docs don't match the current package code." + echo "" + echo "To fix this:" + echo " 1. Run: pnpm docs:build" + echo " 2. Run: pnpm docs:format" + echo " 3. Review and commit the changes" + echo "" + exit 1 + fi diff --git a/biome.json b/biome.json index a1d00a1..cdde150 100644 --- a/biome.json +++ b/biome.json @@ -16,7 +16,8 @@ "!**/coverage", "!packages/appkit-ui/src/react/ui", "!**/routeTree.gen.ts", - "!docs/.docusaurus" + "!docs/.docusaurus", + "!**/typedoc-sidebar.ts" ] }, "formatter": { diff --git a/docs/docs/api/appkit-ui/functions/Accordion.md b/docs/docs/api/appkit-ui/functions/Accordion.md new file mode 100644 index 0000000..305fcf5 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Accordion.md @@ -0,0 +1,17 @@ +# Function: Accordion() + +```ts +function Accordion(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/accordion.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/accordion.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AccordionSingleProps` \| `AccordionMultipleProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AccordionContent.md b/docs/docs/api/appkit-ui/functions/AccordionContent.md new file mode 100644 index 0000000..191ba5f --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AccordionContent.md @@ -0,0 +1,17 @@ +# Function: AccordionContent() + +```ts +function AccordionContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/accordion.tsx:48](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/accordion.tsx#L48) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AccordionContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AccordionItem.md b/docs/docs/api/appkit-ui/functions/AccordionItem.md new file mode 100644 index 0000000..8382e49 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AccordionItem.md @@ -0,0 +1,17 @@ +# Function: AccordionItem() + +```ts +function AccordionItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/accordion.tsx:13](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/accordion.tsx#L13) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AccordionItemProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AccordionTrigger.md b/docs/docs/api/appkit-ui/functions/AccordionTrigger.md new file mode 100644 index 0000000..1b43d7c --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AccordionTrigger.md @@ -0,0 +1,17 @@ +# Function: AccordionTrigger() + +```ts +function AccordionTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/accordion.tsx:26](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/accordion.tsx#L26) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AccordionTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Alert.md b/docs/docs/api/appkit-ui/functions/Alert.md new file mode 100644 index 0000000..929301c --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Alert.md @@ -0,0 +1,17 @@ +# Function: Alert() + +```ts +function Alert(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert.tsx:22](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert.tsx#L22) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `VariantProps`\<(`props?`) => `string`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AlertDescription.md b/docs/docs/api/appkit-ui/functions/AlertDescription.md new file mode 100644 index 0000000..7b7c6d2 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AlertDescription.md @@ -0,0 +1,17 @@ +# Function: AlertDescription() + +```ts +function AlertDescription(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert.tsx:50](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert.tsx#L50) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AlertDialog.md b/docs/docs/api/appkit-ui/functions/AlertDialog.md new file mode 100644 index 0000000..36ca5b2 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AlertDialog.md @@ -0,0 +1,17 @@ +# Function: AlertDialog() + +```ts +function AlertDialog(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert-dialog.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AlertDialogProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AlertDialogAction.md b/docs/docs/api/appkit-ui/functions/AlertDialogAction.md new file mode 100644 index 0000000..4cfa8d0 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AlertDialogAction.md @@ -0,0 +1,17 @@ +# Function: AlertDialogAction() + +```ts +function AlertDialogAction(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert-dialog.tsx:119](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx#L119) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AlertDialogActionProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AlertDialogCancel.md b/docs/docs/api/appkit-ui/functions/AlertDialogCancel.md new file mode 100644 index 0000000..3a31b35 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AlertDialogCancel.md @@ -0,0 +1,17 @@ +# Function: AlertDialogCancel() + +```ts +function AlertDialogCancel(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert-dialog.tsx:131](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx#L131) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AlertDialogCancelProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AlertDialogContent.md b/docs/docs/api/appkit-ui/functions/AlertDialogContent.md new file mode 100644 index 0000000..625078f --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AlertDialogContent.md @@ -0,0 +1,17 @@ +# Function: AlertDialogContent() + +```ts +function AlertDialogContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert-dialog.tsx:45](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx#L45) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AlertDialogContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AlertDialogDescription.md b/docs/docs/api/appkit-ui/functions/AlertDialogDescription.md new file mode 100644 index 0000000..655cd18 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AlertDialogDescription.md @@ -0,0 +1,17 @@ +# Function: AlertDialogDescription() + +```ts +function AlertDialogDescription(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert-dialog.tsx:106](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx#L106) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AlertDialogDescriptionProps` & `RefAttributes`\<`HTMLParagraphElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AlertDialogFooter.md b/docs/docs/api/appkit-ui/functions/AlertDialogFooter.md new file mode 100644 index 0000000..c41363c --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AlertDialogFooter.md @@ -0,0 +1,17 @@ +# Function: AlertDialogFooter() + +```ts +function AlertDialogFooter(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert-dialog.tsx:77](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx#L77) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AlertDialogHeader.md b/docs/docs/api/appkit-ui/functions/AlertDialogHeader.md new file mode 100644 index 0000000..b0ba527 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AlertDialogHeader.md @@ -0,0 +1,17 @@ +# Function: AlertDialogHeader() + +```ts +function AlertDialogHeader(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert-dialog.tsx:64](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx#L64) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AlertDialogOverlay.md b/docs/docs/api/appkit-ui/functions/AlertDialogOverlay.md new file mode 100644 index 0000000..cef81c8 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AlertDialogOverlay.md @@ -0,0 +1,17 @@ +# Function: AlertDialogOverlay() + +```ts +function AlertDialogOverlay(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert-dialog.tsx:29](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx#L29) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AlertDialogOverlayProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AlertDialogPortal.md b/docs/docs/api/appkit-ui/functions/AlertDialogPortal.md new file mode 100644 index 0000000..ffdc853 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AlertDialogPortal.md @@ -0,0 +1,17 @@ +# Function: AlertDialogPortal() + +```ts +function AlertDialogPortal(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert-dialog.tsx:21](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx#L21) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AlertDialogPortalProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AlertDialogTitle.md b/docs/docs/api/appkit-ui/functions/AlertDialogTitle.md new file mode 100644 index 0000000..57a7048 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AlertDialogTitle.md @@ -0,0 +1,17 @@ +# Function: AlertDialogTitle() + +```ts +function AlertDialogTitle(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert-dialog.tsx:93](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx#L93) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AlertDialogTitleProps` & `RefAttributes`\<`HTMLHeadingElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AlertDialogTrigger.md b/docs/docs/api/appkit-ui/functions/AlertDialogTrigger.md new file mode 100644 index 0000000..b4161a4 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AlertDialogTrigger.md @@ -0,0 +1,17 @@ +# Function: AlertDialogTrigger() + +```ts +function AlertDialogTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert-dialog.tsx:13](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx#L13) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AlertDialogTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AlertTitle.md b/docs/docs/api/appkit-ui/functions/AlertTitle.md new file mode 100644 index 0000000..54b3144 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AlertTitle.md @@ -0,0 +1,17 @@ +# Function: AlertTitle() + +```ts +function AlertTitle(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/alert.tsx:37](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert.tsx#L37) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AspectRatio.md b/docs/docs/api/appkit-ui/functions/AspectRatio.md new file mode 100644 index 0000000..d0e6c9b --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AspectRatio.md @@ -0,0 +1,17 @@ +# Function: AspectRatio() + +```ts +function AspectRatio(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/aspect-ratio.tsx:5](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/aspect-ratio.tsx#L5) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AspectRatioProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Avatar.md b/docs/docs/api/appkit-ui/functions/Avatar.md new file mode 100644 index 0000000..e8a65f1 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Avatar.md @@ -0,0 +1,17 @@ +# Function: Avatar() + +```ts +function Avatar(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/avatar.tsx:6](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/avatar.tsx#L6) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AvatarProps` & `RefAttributes`\<`HTMLSpanElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AvatarFallback.md b/docs/docs/api/appkit-ui/functions/AvatarFallback.md new file mode 100644 index 0000000..7b76805 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AvatarFallback.md @@ -0,0 +1,17 @@ +# Function: AvatarFallback() + +```ts +function AvatarFallback(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/avatar.tsx:35](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/avatar.tsx#L35) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AvatarFallbackProps` & `RefAttributes`\<`HTMLSpanElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/AvatarImage.md b/docs/docs/api/appkit-ui/functions/AvatarImage.md new file mode 100644 index 0000000..59e29ed --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/AvatarImage.md @@ -0,0 +1,17 @@ +# Function: AvatarImage() + +```ts +function AvatarImage(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/avatar.tsx:22](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/avatar.tsx#L22) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `AvatarImageProps` & `RefAttributes`\<`HTMLImageElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Badge.md b/docs/docs/api/appkit-ui/functions/Badge.md new file mode 100644 index 0000000..66338ca --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Badge.md @@ -0,0 +1,17 @@ +# Function: Badge() + +```ts +function Badge(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/badge.tsx:28](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/badge.tsx#L28) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLSpanElement`\> & `HTMLAttributes`\<`HTMLSpanElement`\> & `VariantProps`\<(`props?`) => `string`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/BaseChart.md b/docs/docs/api/appkit-ui/functions/BaseChart.md new file mode 100644 index 0000000..aee06ad --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/BaseChart.md @@ -0,0 +1,20 @@ +# Function: BaseChart() + +```ts +function BaseChart(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:105](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L105) + +Base chart component that handles both Arrow and JSON data. +Renders using ECharts for consistent output across both formats. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | [`BaseChartProps`](../interfaces/BaseChartProps.md) | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Breadcrumb.md b/docs/docs/api/appkit-ui/functions/Breadcrumb.md new file mode 100644 index 0000000..4b9b116 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Breadcrumb.md @@ -0,0 +1,17 @@ +# Function: Breadcrumb() + +```ts +function Breadcrumb(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/breadcrumb.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/BreadcrumbEllipsis.md b/docs/docs/api/appkit-ui/functions/BreadcrumbEllipsis.md new file mode 100644 index 0000000..29aa06e --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/BreadcrumbEllipsis.md @@ -0,0 +1,17 @@ +# Function: BreadcrumbEllipsis() + +```ts +function BreadcrumbEllipsis(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/breadcrumb.tsx:83](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx#L83) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLSpanElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/BreadcrumbItem.md b/docs/docs/api/appkit-ui/functions/BreadcrumbItem.md new file mode 100644 index 0000000..d27d177 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/BreadcrumbItem.md @@ -0,0 +1,17 @@ +# Function: BreadcrumbItem() + +```ts +function BreadcrumbItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/breadcrumb.tsx:24](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx#L24) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`LiHTMLAttributes`\<`HTMLLIElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/BreadcrumbLink.md b/docs/docs/api/appkit-ui/functions/BreadcrumbLink.md new file mode 100644 index 0000000..688a2ef --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/BreadcrumbLink.md @@ -0,0 +1,17 @@ +# Function: BreadcrumbLink() + +```ts +function BreadcrumbLink(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/breadcrumb.tsx:34](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx#L34) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLAnchorElement`\> & `AnchorHTMLAttributes`\<`HTMLAnchorElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/BreadcrumbList.md b/docs/docs/api/appkit-ui/functions/BreadcrumbList.md new file mode 100644 index 0000000..da535f2 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/BreadcrumbList.md @@ -0,0 +1,17 @@ +# Function: BreadcrumbList() + +```ts +function BreadcrumbList(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/breadcrumb.tsx:11](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx#L11) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`OlHTMLAttributes`\<`HTMLOListElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/BreadcrumbPage.md b/docs/docs/api/appkit-ui/functions/BreadcrumbPage.md new file mode 100644 index 0000000..35785a8 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/BreadcrumbPage.md @@ -0,0 +1,17 @@ +# Function: BreadcrumbPage() + +```ts +function BreadcrumbPage(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/breadcrumb.tsx:52](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx#L52) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLSpanElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/BreadcrumbSeparator.md b/docs/docs/api/appkit-ui/functions/BreadcrumbSeparator.md new file mode 100644 index 0000000..a796cf7 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/BreadcrumbSeparator.md @@ -0,0 +1,17 @@ +# Function: BreadcrumbSeparator() + +```ts +function BreadcrumbSeparator(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/breadcrumb.tsx:65](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx#L65) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`LiHTMLAttributes`\<`HTMLLIElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Button.md b/docs/docs/api/appkit-ui/functions/Button.md new file mode 100644 index 0000000..e0ba1c6 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Button.md @@ -0,0 +1,17 @@ +# Function: Button() + +```ts +function Button(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/button.tsx:39](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/button.tsx#L39) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLButtonElement`\> & `ButtonHTMLAttributes`\<`HTMLButtonElement`\> & `VariantProps`\<(`props?`) => `string`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ButtonGroup.md b/docs/docs/api/appkit-ui/functions/ButtonGroup.md new file mode 100644 index 0000000..a2e2605 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ButtonGroup.md @@ -0,0 +1,17 @@ +# Function: ButtonGroup() + +```ts +function ButtonGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/button-group.tsx:24](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/button-group.tsx#L24) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `VariantProps`\<(`props?`) => `string`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ButtonGroupSeparator.md b/docs/docs/api/appkit-ui/functions/ButtonGroupSeparator.md new file mode 100644 index 0000000..ef9c427 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ButtonGroupSeparator.md @@ -0,0 +1,17 @@ +# Function: ButtonGroupSeparator() + +```ts +function ButtonGroupSeparator(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/button-group.tsx:60](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/button-group.tsx#L60) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SeparatorProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ButtonGroupText.md b/docs/docs/api/appkit-ui/functions/ButtonGroupText.md new file mode 100644 index 0000000..0c65ac2 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ButtonGroupText.md @@ -0,0 +1,17 @@ +# Function: ButtonGroupText() + +```ts +function ButtonGroupText(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/button-group.tsx:40](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/button-group.tsx#L40) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Calendar.md b/docs/docs/api/appkit-ui/functions/Calendar.md new file mode 100644 index 0000000..7e96d53 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Calendar.md @@ -0,0 +1,17 @@ +# Function: Calendar() + +```ts +function Calendar(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/calendar.tsx:15](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/calendar.tsx#L15) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DayPickerProps` & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CalendarDayButton.md b/docs/docs/api/appkit-ui/functions/CalendarDayButton.md new file mode 100644 index 0000000..d8ccc82 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CalendarDayButton.md @@ -0,0 +1,17 @@ +# Function: CalendarDayButton() + +```ts +function CalendarDayButton(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/calendar.tsx:179](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/calendar.tsx#L179) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `object` & `ButtonHTMLAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Card.md b/docs/docs/api/appkit-ui/functions/Card.md new file mode 100644 index 0000000..fe8ddfe --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Card.md @@ -0,0 +1,17 @@ +# Function: Card() + +```ts +function Card(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/card.tsx:5](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx#L5) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CardAction.md b/docs/docs/api/appkit-ui/functions/CardAction.md new file mode 100644 index 0000000..03c8ce4 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CardAction.md @@ -0,0 +1,17 @@ +# Function: CardAction() + +```ts +function CardAction(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/card.tsx:51](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx#L51) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CardContent.md b/docs/docs/api/appkit-ui/functions/CardContent.md new file mode 100644 index 0000000..0428da6 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CardContent.md @@ -0,0 +1,17 @@ +# Function: CardContent() + +```ts +function CardContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/card.tsx:64](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx#L64) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CardDescription.md b/docs/docs/api/appkit-ui/functions/CardDescription.md new file mode 100644 index 0000000..67287fe --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CardDescription.md @@ -0,0 +1,17 @@ +# Function: CardDescription() + +```ts +function CardDescription(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/card.tsx:41](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx#L41) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CardFooter.md b/docs/docs/api/appkit-ui/functions/CardFooter.md new file mode 100644 index 0000000..5fbe6a7 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CardFooter.md @@ -0,0 +1,17 @@ +# Function: CardFooter() + +```ts +function CardFooter(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/card.tsx:74](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx#L74) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CardHeader.md b/docs/docs/api/appkit-ui/functions/CardHeader.md new file mode 100644 index 0000000..fe8abf2 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CardHeader.md @@ -0,0 +1,17 @@ +# Function: CardHeader() + +```ts +function CardHeader(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/card.tsx:18](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx#L18) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CardTitle.md b/docs/docs/api/appkit-ui/functions/CardTitle.md new file mode 100644 index 0000000..aaaa8ab --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CardTitle.md @@ -0,0 +1,17 @@ +# Function: CardTitle() + +```ts +function CardTitle(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/card.tsx:31](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/card.tsx#L31) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Carousel.md b/docs/docs/api/appkit-ui/functions/Carousel.md new file mode 100644 index 0000000..a4f65b1 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Carousel.md @@ -0,0 +1,17 @@ +# Function: Carousel() + +```ts +function Carousel(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/carousel.tsx:43](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/carousel.tsx#L43) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `CarouselProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CarouselContent.md b/docs/docs/api/appkit-ui/functions/CarouselContent.md new file mode 100644 index 0000000..081dba9 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CarouselContent.md @@ -0,0 +1,17 @@ +# Function: CarouselContent() + +```ts +function CarouselContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/carousel.tsx:133](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/carousel.tsx#L133) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CarouselItem.md b/docs/docs/api/appkit-ui/functions/CarouselItem.md new file mode 100644 index 0000000..c83a7c8 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CarouselItem.md @@ -0,0 +1,17 @@ +# Function: CarouselItem() + +```ts +function CarouselItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/carousel.tsx:154](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/carousel.tsx#L154) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CarouselNext.md b/docs/docs/api/appkit-ui/functions/CarouselNext.md new file mode 100644 index 0000000..814b740 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CarouselNext.md @@ -0,0 +1,17 @@ +# Function: CarouselNext() + +```ts +function CarouselNext(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/carousel.tsx:202](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/carousel.tsx#L202) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLButtonElement`\> & `ButtonHTMLAttributes`\<`HTMLButtonElement`\> & `VariantProps`\<(`props?`) => `string`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CarouselPrevious.md b/docs/docs/api/appkit-ui/functions/CarouselPrevious.md new file mode 100644 index 0000000..b9d8657 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CarouselPrevious.md @@ -0,0 +1,17 @@ +# Function: CarouselPrevious() + +```ts +function CarouselPrevious(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/carousel.tsx:172](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/carousel.tsx#L172) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLButtonElement`\> & `ButtonHTMLAttributes`\<`HTMLButtonElement`\> & `VariantProps`\<(`props?`) => `string`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ChartContainer.md b/docs/docs/api/appkit-ui/functions/ChartContainer.md new file mode 100644 index 0000000..27d6c8a --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ChartContainer.md @@ -0,0 +1,17 @@ +# Function: ChartContainer() + +```ts +function ChartContainer(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/chart.tsx:37](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/chart.tsx#L37) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ChartLegendContent.md b/docs/docs/api/appkit-ui/functions/ChartLegendContent.md new file mode 100644 index 0000000..7bc70eb --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ChartLegendContent.md @@ -0,0 +1,17 @@ +# Function: ChartLegendContent() + +```ts +function ChartLegendContent(__namedParameters): Element | null; +``` + +Defined in: [packages/appkit-ui/src/react/ui/chart.tsx:267](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/chart.tsx#L267) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `Pick`\<`Props`, `"verticalAlign"`\> & `object` | + +## Returns + +`Element` \| `null` diff --git a/docs/docs/api/appkit-ui/functions/ChartStyle.md b/docs/docs/api/appkit-ui/functions/ChartStyle.md new file mode 100644 index 0000000..6c1e232 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ChartStyle.md @@ -0,0 +1,19 @@ +# Function: ChartStyle() + +```ts +function ChartStyle(__namedParameters): Element | null; +``` + +Defined in: [packages/appkit-ui/src/react/ui/chart.tsx:72](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/chart.tsx#L72) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | \{ `config`: [`ChartConfig`](../type-aliases/ChartConfig.md); `id`: `string`; \} | +| `__namedParameters.config` | [`ChartConfig`](../type-aliases/ChartConfig.md) | +| `__namedParameters.id` | `string` | + +## Returns + +`Element` \| `null` diff --git a/docs/docs/api/appkit-ui/functions/ChartTooltipContent.md b/docs/docs/api/appkit-ui/functions/ChartTooltipContent.md new file mode 100644 index 0000000..b5bf702 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ChartTooltipContent.md @@ -0,0 +1,17 @@ +# Function: ChartTooltipContent() + +```ts +function ChartTooltipContent(__namedParameters): Element | null; +``` + +Defined in: [packages/appkit-ui/src/react/ui/chart.tsx:107](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/chart.tsx#L107) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` \| `null` diff --git a/docs/docs/api/appkit-ui/functions/ChartWrapper.md b/docs/docs/api/appkit-ui/functions/ChartWrapper.md new file mode 100644 index 0000000..32536b1 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ChartWrapper.md @@ -0,0 +1,38 @@ +# Function: ChartWrapper() + +```ts +function ChartWrapper(props): Element; +``` + +Defined in: [packages/appkit-ui/src/react/charts/wrapper.tsx:157](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/wrapper.tsx#L157) + +Wrapper component for charts. +Handles data fetching (query mode) or direct data injection (data mode). + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`ChartWrapperProps`](../type-aliases/ChartWrapperProps.md) | + +## Returns + +`Element` + +## Examples + +```tsx + + {(data) => } + +``` + +```tsx + + {(data) => } + +``` diff --git a/docs/docs/api/appkit-ui/functions/Checkbox.md b/docs/docs/api/appkit-ui/functions/Checkbox.md new file mode 100644 index 0000000..43b23ba --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Checkbox.md @@ -0,0 +1,17 @@ +# Function: Checkbox() + +```ts +function Checkbox(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/checkbox.tsx:9](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/checkbox.tsx#L9) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `CheckboxProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Collapsible.md b/docs/docs/api/appkit-ui/functions/Collapsible.md new file mode 100644 index 0000000..fe8784b --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Collapsible.md @@ -0,0 +1,17 @@ +# Function: Collapsible() + +```ts +function Collapsible(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/collapsible.tsx:3](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/collapsible.tsx#L3) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `CollapsibleProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CollapsibleContent.md b/docs/docs/api/appkit-ui/functions/CollapsibleContent.md new file mode 100644 index 0000000..57a1917 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CollapsibleContent.md @@ -0,0 +1,17 @@ +# Function: CollapsibleContent() + +```ts +function CollapsibleContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/collapsible.tsx:20](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/collapsible.tsx#L20) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `CollapsibleContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CollapsibleTrigger.md b/docs/docs/api/appkit-ui/functions/CollapsibleTrigger.md new file mode 100644 index 0000000..afccf77 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CollapsibleTrigger.md @@ -0,0 +1,17 @@ +# Function: CollapsibleTrigger() + +```ts +function CollapsibleTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/collapsible.tsx:9](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/collapsible.tsx#L9) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `CollapsibleTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Command.md b/docs/docs/api/appkit-ui/functions/Command.md new file mode 100644 index 0000000..d1e9dfe --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Command.md @@ -0,0 +1,17 @@ +# Function: Command() + +```ts +function Command(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/command.tsx:14](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx#L14) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `Children` & `Pick`\<`Pick`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, `"key"` \| keyof HTMLAttributes\\> & `object` & `object`, `"asChild"` \| `"key"` \| keyof HTMLAttributes\\> & `object` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CommandDialog.md b/docs/docs/api/appkit-ui/functions/CommandDialog.md new file mode 100644 index 0000000..1b046ca --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CommandDialog.md @@ -0,0 +1,17 @@ +# Function: CommandDialog() + +```ts +function CommandDialog(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/command.tsx:30](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx#L30) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogProps` & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CommandEmpty.md b/docs/docs/api/appkit-ui/functions/CommandEmpty.md new file mode 100644 index 0000000..fb3692b --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CommandEmpty.md @@ -0,0 +1,17 @@ +# Function: CommandEmpty() + +```ts +function CommandEmpty(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/command.tsx:99](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx#L99) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `Children` & `Pick`\<`Pick`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, `"key"` \| keyof HTMLAttributes\\> & `object` & `object`, `"asChild"` \| `"key"` \| keyof HTMLAttributes\\> & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CommandGroup.md b/docs/docs/api/appkit-ui/functions/CommandGroup.md new file mode 100644 index 0000000..d8c9ade --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CommandGroup.md @@ -0,0 +1,17 @@ +# Function: CommandGroup() + +```ts +function CommandGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/command.tsx:111](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx#L111) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `Children` & `Omit`\<`Pick`\<`Pick`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, `"key"` \| keyof HTMLAttributes\\> & `object` & `object`, `"asChild"` \| `"key"` \| keyof HTMLAttributes\\>, `"value"` \| `"heading"`\> & `object` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CommandInput.md b/docs/docs/api/appkit-ui/functions/CommandInput.md new file mode 100644 index 0000000..67e2ceb --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CommandInput.md @@ -0,0 +1,17 @@ +# Function: CommandInput() + +```ts +function CommandInput(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/command.tsx:61](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx#L61) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `Omit`\<`Pick`\<`Pick`\<`DetailedHTMLProps`\<`InputHTMLAttributes`\<`HTMLInputElement`\>, `HTMLInputElement`\>, `"key"` \| keyof InputHTMLAttributes\\> & `object` & `object`, `"asChild"` \| `"key"` \| keyof InputHTMLAttributes\\>, `"value"` \| `"onChange"` \| `"type"`\> & `object` & `RefAttributes`\<`HTMLInputElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CommandItem.md b/docs/docs/api/appkit-ui/functions/CommandItem.md new file mode 100644 index 0000000..7ff3205 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CommandItem.md @@ -0,0 +1,17 @@ +# Function: CommandItem() + +```ts +function CommandItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/command.tsx:140](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx#L140) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `Children` & `Omit`\<`Pick`\<`Pick`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, `"key"` \| keyof HTMLAttributes\\> & `object` & `object`, `"asChild"` \| `"key"` \| keyof HTMLAttributes\\>, `"value"` \| `"onSelect"` \| `"disabled"`\> & `object` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CommandList.md b/docs/docs/api/appkit-ui/functions/CommandList.md new file mode 100644 index 0000000..c727447 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CommandList.md @@ -0,0 +1,17 @@ +# Function: CommandList() + +```ts +function CommandList(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/command.tsx:83](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx#L83) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `Children` & `Pick`\<`Pick`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, `"key"` \| keyof HTMLAttributes\\> & `object` & `object`, `"asChild"` \| `"key"` \| keyof HTMLAttributes\\> & `object` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CommandSeparator.md b/docs/docs/api/appkit-ui/functions/CommandSeparator.md new file mode 100644 index 0000000..2128082 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CommandSeparator.md @@ -0,0 +1,17 @@ +# Function: CommandSeparator() + +```ts +function CommandSeparator(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/command.tsx:127](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx#L127) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `Pick`\<`Pick`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, `"key"` \| keyof HTMLAttributes\\> & `object` & `object`, `"asChild"` \| `"key"` \| keyof HTMLAttributes\\> & `object` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/CommandShortcut.md b/docs/docs/api/appkit-ui/functions/CommandShortcut.md new file mode 100644 index 0000000..5134a1b --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/CommandShortcut.md @@ -0,0 +1,17 @@ +# Function: CommandShortcut() + +```ts +function CommandShortcut(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/command.tsx:156](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/command.tsx#L156) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLSpanElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenu.md b/docs/docs/api/appkit-ui/functions/ContextMenu.md new file mode 100644 index 0000000..a53b93c --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenu.md @@ -0,0 +1,17 @@ +# Function: ContextMenu() + +```ts +function ContextMenu(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:9](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L9) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuCheckboxItem.md b/docs/docs/api/appkit-ui/functions/ContextMenuCheckboxItem.md new file mode 100644 index 0000000..a4d3311 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuCheckboxItem.md @@ -0,0 +1,17 @@ +# Function: ContextMenuCheckboxItem() + +```ts +function ContextMenuCheckboxItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:137](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L137) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuCheckboxItemProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuContent.md b/docs/docs/api/appkit-ui/functions/ContextMenuContent.md new file mode 100644 index 0000000..dfe8281 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuContent.md @@ -0,0 +1,17 @@ +# Function: ContextMenuContent() + +```ts +function ContextMenuContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:96](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L96) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuGroup.md b/docs/docs/api/appkit-ui/functions/ContextMenuGroup.md new file mode 100644 index 0000000..792782a --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuGroup.md @@ -0,0 +1,17 @@ +# Function: ContextMenuGroup() + +```ts +function ContextMenuGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:23](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L23) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuGroupProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuItem.md b/docs/docs/api/appkit-ui/functions/ContextMenuItem.md new file mode 100644 index 0000000..ef11075 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuItem.md @@ -0,0 +1,17 @@ +# Function: ContextMenuItem() + +```ts +function ContextMenuItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:114](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L114) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuItemProps` & `RefAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuLabel.md b/docs/docs/api/appkit-ui/functions/ContextMenuLabel.md new file mode 100644 index 0000000..3ca4be8 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuLabel.md @@ -0,0 +1,17 @@ +# Function: ContextMenuLabel() + +```ts +function ContextMenuLabel(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:187](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L187) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuLabelProps` & `RefAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuPortal.md b/docs/docs/api/appkit-ui/functions/ContextMenuPortal.md new file mode 100644 index 0000000..d928112 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuPortal.md @@ -0,0 +1,17 @@ +# Function: ContextMenuPortal() + +```ts +function ContextMenuPortal(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:31](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L31) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuPortalProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuRadioGroup.md b/docs/docs/api/appkit-ui/functions/ContextMenuRadioGroup.md new file mode 100644 index 0000000..cc994fe --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuRadioGroup.md @@ -0,0 +1,17 @@ +# Function: ContextMenuRadioGroup() + +```ts +function ContextMenuRadioGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:45](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L45) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuRadioGroupProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuRadioItem.md b/docs/docs/api/appkit-ui/functions/ContextMenuRadioItem.md new file mode 100644 index 0000000..96ad758 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuRadioItem.md @@ -0,0 +1,17 @@ +# Function: ContextMenuRadioItem() + +```ts +function ContextMenuRadioItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:163](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L163) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuRadioItemProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuSeparator.md b/docs/docs/api/appkit-ui/functions/ContextMenuSeparator.md new file mode 100644 index 0000000..62ff1ab --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuSeparator.md @@ -0,0 +1,17 @@ +# Function: ContextMenuSeparator() + +```ts +function ContextMenuSeparator(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:207](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L207) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuSeparatorProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuShortcut.md b/docs/docs/api/appkit-ui/functions/ContextMenuShortcut.md new file mode 100644 index 0000000..f9d7fe8 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuShortcut.md @@ -0,0 +1,17 @@ +# Function: ContextMenuShortcut() + +```ts +function ContextMenuShortcut(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:220](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L220) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLSpanElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuSub.md b/docs/docs/api/appkit-ui/functions/ContextMenuSub.md new file mode 100644 index 0000000..a415792 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuSub.md @@ -0,0 +1,17 @@ +# Function: ContextMenuSub() + +```ts +function ContextMenuSub(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:39](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L39) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuSubProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuSubContent.md b/docs/docs/api/appkit-ui/functions/ContextMenuSubContent.md new file mode 100644 index 0000000..5f2c50b --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuSubContent.md @@ -0,0 +1,17 @@ +# Function: ContextMenuSubContent() + +```ts +function ContextMenuSubContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:80](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L80) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuSubContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuSubTrigger.md b/docs/docs/api/appkit-ui/functions/ContextMenuSubTrigger.md new file mode 100644 index 0000000..ed06318 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuSubTrigger.md @@ -0,0 +1,17 @@ +# Function: ContextMenuSubTrigger() + +```ts +function ContextMenuSubTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:56](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L56) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuSubTriggerProps` & `RefAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ContextMenuTrigger.md b/docs/docs/api/appkit-ui/functions/ContextMenuTrigger.md new file mode 100644 index 0000000..b7711bd --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ContextMenuTrigger.md @@ -0,0 +1,17 @@ +# Function: ContextMenuTrigger() + +```ts +function ContextMenuTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/context-menu.tsx:15](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/context-menu.tsx#L15) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ContextMenuTriggerProps` & `RefAttributes`\<`HTMLSpanElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DataTable.md b/docs/docs/api/appkit-ui/functions/DataTable.md new file mode 100644 index 0000000..69960e7 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DataTable.md @@ -0,0 +1,54 @@ +# Function: DataTable() + +```ts +function DataTable(props): Element; +``` + +Defined in: [packages/appkit-ui/src/react/table/data-table.tsx:68](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/table/data-table.tsx#L68) + +Production-ready data table with automatic data fetching and state management +Features: + - Automatic column generation from data structure + - Integrated with useAnalyticsQuery for data fetching + - Built-in loading, error, and empty states + - Dynamic filtering, sorting and pagination + - Column visibility controls + - Responsive design + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `props` | `DataTableProps` | Props for the DataTable component | + +## Returns + +`Element` + +- The rendered data table component + +## Examples + +```ts +// Opinionated mode + +``` + +```ts +// full control mode + + {(table) => ( +
+

Custom Table UI

+ {table.getRowModel().rows.map(row => ( +
{row.original.name}
+ ))} +
+ )} +
+``` diff --git a/docs/docs/api/appkit-ui/functions/Dialog.md b/docs/docs/api/appkit-ui/functions/Dialog.md new file mode 100644 index 0000000..d486213 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Dialog.md @@ -0,0 +1,17 @@ +# Function: Dialog() + +```ts +function Dialog(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dialog.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DialogClose.md b/docs/docs/api/appkit-ui/functions/DialogClose.md new file mode 100644 index 0000000..2b88531 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DialogClose.md @@ -0,0 +1,17 @@ +# Function: DialogClose() + +```ts +function DialogClose(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dialog.tsx:25](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx#L25) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogCloseProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DialogContent.md b/docs/docs/api/appkit-ui/functions/DialogContent.md new file mode 100644 index 0000000..77dab27 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DialogContent.md @@ -0,0 +1,17 @@ +# Function: DialogContent() + +```ts +function DialogContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dialog.tsx:47](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx#L47) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogContentProps` & `RefAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DialogDescription.md b/docs/docs/api/appkit-ui/functions/DialogDescription.md new file mode 100644 index 0000000..8fe5bb7 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DialogDescription.md @@ -0,0 +1,17 @@ +# Function: DialogDescription() + +```ts +function DialogDescription(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dialog.tsx:117](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx#L117) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogDescriptionProps` & `RefAttributes`\<`HTMLParagraphElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DialogFooter.md b/docs/docs/api/appkit-ui/functions/DialogFooter.md new file mode 100644 index 0000000..b4e4d47 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DialogFooter.md @@ -0,0 +1,17 @@ +# Function: DialogFooter() + +```ts +function DialogFooter(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dialog.tsx:91](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx#L91) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DialogHeader.md b/docs/docs/api/appkit-ui/functions/DialogHeader.md new file mode 100644 index 0000000..539ef6a --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DialogHeader.md @@ -0,0 +1,17 @@ +# Function: DialogHeader() + +```ts +function DialogHeader(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dialog.tsx:81](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx#L81) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DialogOverlay.md b/docs/docs/api/appkit-ui/functions/DialogOverlay.md new file mode 100644 index 0000000..e50e683 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DialogOverlay.md @@ -0,0 +1,17 @@ +# Function: DialogOverlay() + +```ts +function DialogOverlay(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dialog.tsx:31](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx#L31) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogOverlayProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DialogPortal.md b/docs/docs/api/appkit-ui/functions/DialogPortal.md new file mode 100644 index 0000000..42ec8ca --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DialogPortal.md @@ -0,0 +1,17 @@ +# Function: DialogPortal() + +```ts +function DialogPortal(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dialog.tsx:19](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx#L19) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogPortalProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DialogTitle.md b/docs/docs/api/appkit-ui/functions/DialogTitle.md new file mode 100644 index 0000000..0cd9454 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DialogTitle.md @@ -0,0 +1,17 @@ +# Function: DialogTitle() + +```ts +function DialogTitle(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dialog.tsx:104](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx#L104) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogTitleProps` & `RefAttributes`\<`HTMLHeadingElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DialogTrigger.md b/docs/docs/api/appkit-ui/functions/DialogTrigger.md new file mode 100644 index 0000000..47574cd --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DialogTrigger.md @@ -0,0 +1,17 @@ +# Function: DialogTrigger() + +```ts +function DialogTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dialog.tsx:13](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dialog.tsx#L13) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Drawer.md b/docs/docs/api/appkit-ui/functions/Drawer.md new file mode 100644 index 0000000..9bcdb59 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Drawer.md @@ -0,0 +1,17 @@ +# Function: Drawer() + +```ts +function Drawer(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/drawer.tsx:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx#L8) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DrawerClose.md b/docs/docs/api/appkit-ui/functions/DrawerClose.md new file mode 100644 index 0000000..78c50d1 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DrawerClose.md @@ -0,0 +1,17 @@ +# Function: DrawerClose() + +```ts +function DrawerClose(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/drawer.tsx:26](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx#L26) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogCloseProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DrawerContent.md b/docs/docs/api/appkit-ui/functions/DrawerContent.md new file mode 100644 index 0000000..7bd425a --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DrawerContent.md @@ -0,0 +1,17 @@ +# Function: DrawerContent() + +```ts +function DrawerContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/drawer.tsx:48](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx#L48) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `Omit`\<`DialogContentProps` & `RefAttributes`\<`HTMLDivElement`\>, `"ref"`\> & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DrawerDescription.md b/docs/docs/api/appkit-ui/functions/DrawerDescription.md new file mode 100644 index 0000000..4d0a61d --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DrawerDescription.md @@ -0,0 +1,17 @@ +# Function: DrawerDescription() + +```ts +function DrawerDescription(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/drawer.tsx:111](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx#L111) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogDescriptionProps` & `RefAttributes`\<`HTMLParagraphElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DrawerFooter.md b/docs/docs/api/appkit-ui/functions/DrawerFooter.md new file mode 100644 index 0000000..e1bfe57 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DrawerFooter.md @@ -0,0 +1,17 @@ +# Function: DrawerFooter() + +```ts +function DrawerFooter(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/drawer.tsx:88](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx#L88) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DrawerHeader.md b/docs/docs/api/appkit-ui/functions/DrawerHeader.md new file mode 100644 index 0000000..7f217f5 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DrawerHeader.md @@ -0,0 +1,17 @@ +# Function: DrawerHeader() + +```ts +function DrawerHeader(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/drawer.tsx:75](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx#L75) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DrawerOverlay.md b/docs/docs/api/appkit-ui/functions/DrawerOverlay.md new file mode 100644 index 0000000..a80bb1a --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DrawerOverlay.md @@ -0,0 +1,17 @@ +# Function: DrawerOverlay() + +```ts +function DrawerOverlay(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/drawer.tsx:32](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx#L32) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `Omit`\<`DialogOverlayProps` & `RefAttributes`\<`HTMLDivElement`\>, `"ref"`\> & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DrawerPortal.md b/docs/docs/api/appkit-ui/functions/DrawerPortal.md new file mode 100644 index 0000000..128f352 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DrawerPortal.md @@ -0,0 +1,17 @@ +# Function: DrawerPortal() + +```ts +function DrawerPortal(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/drawer.tsx:20](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx#L20) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogPortalProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DrawerTitle.md b/docs/docs/api/appkit-ui/functions/DrawerTitle.md new file mode 100644 index 0000000..8489e37 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DrawerTitle.md @@ -0,0 +1,17 @@ +# Function: DrawerTitle() + +```ts +function DrawerTitle(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/drawer.tsx:98](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx#L98) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogTitleProps` & `RefAttributes`\<`HTMLHeadingElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DrawerTrigger.md b/docs/docs/api/appkit-ui/functions/DrawerTrigger.md new file mode 100644 index 0000000..ec21d38 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DrawerTrigger.md @@ -0,0 +1,17 @@ +# Function: DrawerTrigger() + +```ts +function DrawerTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/drawer.tsx:14](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/drawer.tsx#L14) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenu.md b/docs/docs/api/appkit-ui/functions/DropdownMenu.md new file mode 100644 index 0000000..454265d --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenu.md @@ -0,0 +1,17 @@ +# Function: DropdownMenu() + +```ts +function DropdownMenu(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuCheckboxItem.md b/docs/docs/api/appkit-ui/functions/DropdownMenuCheckboxItem.md new file mode 100644 index 0000000..bcf9743 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuCheckboxItem.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuCheckboxItem() + +```ts +function DropdownMenuCheckboxItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:83](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L83) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuCheckboxItemProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuContent.md b/docs/docs/api/appkit-ui/functions/DropdownMenuContent.md new file mode 100644 index 0000000..2497a06 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuContent.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuContent() + +```ts +function DropdownMenuContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:32](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L32) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuGroup.md b/docs/docs/api/appkit-ui/functions/DropdownMenuGroup.md new file mode 100644 index 0000000..1c92c4c --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuGroup.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuGroup() + +```ts +function DropdownMenuGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:52](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L52) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuGroupProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuItem.md b/docs/docs/api/appkit-ui/functions/DropdownMenuItem.md new file mode 100644 index 0000000..01735b1 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuItem.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuItem() + +```ts +function DropdownMenuItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:60](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L60) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuItemProps` & `RefAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuLabel.md b/docs/docs/api/appkit-ui/functions/DropdownMenuLabel.md new file mode 100644 index 0000000..2cafa55 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuLabel.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuLabel() + +```ts +function DropdownMenuLabel(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:144](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L144) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuLabelProps` & `RefAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuPortal.md b/docs/docs/api/appkit-ui/functions/DropdownMenuPortal.md new file mode 100644 index 0000000..f246869 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuPortal.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuPortal() + +```ts +function DropdownMenuPortal(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:13](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L13) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuPortalProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuRadioGroup.md b/docs/docs/api/appkit-ui/functions/DropdownMenuRadioGroup.md new file mode 100644 index 0000000..9f1cff4 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuRadioGroup.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuRadioGroup() + +```ts +function DropdownMenuRadioGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:109](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L109) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuRadioGroupProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuRadioItem.md b/docs/docs/api/appkit-ui/functions/DropdownMenuRadioItem.md new file mode 100644 index 0000000..4ebd2da --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuRadioItem.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuRadioItem() + +```ts +function DropdownMenuRadioItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:120](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L120) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuRadioItemProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuSeparator.md b/docs/docs/api/appkit-ui/functions/DropdownMenuSeparator.md new file mode 100644 index 0000000..e32a633 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuSeparator.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuSeparator() + +```ts +function DropdownMenuSeparator(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:164](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L164) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuSeparatorProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuShortcut.md b/docs/docs/api/appkit-ui/functions/DropdownMenuShortcut.md new file mode 100644 index 0000000..f55d500 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuShortcut.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuShortcut() + +```ts +function DropdownMenuShortcut(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:177](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L177) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLSpanElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuSub.md b/docs/docs/api/appkit-ui/functions/DropdownMenuSub.md new file mode 100644 index 0000000..b2e1c23 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuSub.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuSub() + +```ts +function DropdownMenuSub(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:193](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L193) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuSubProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuSubContent.md b/docs/docs/api/appkit-ui/functions/DropdownMenuSubContent.md new file mode 100644 index 0000000..9bc49c5 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuSubContent.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuSubContent() + +```ts +function DropdownMenuSubContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:223](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L223) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuSubContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuSubTrigger.md b/docs/docs/api/appkit-ui/functions/DropdownMenuSubTrigger.md new file mode 100644 index 0000000..bbd9511 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuSubTrigger.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuSubTrigger() + +```ts +function DropdownMenuSubTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:199](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L199) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuSubTriggerProps` & `RefAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/DropdownMenuTrigger.md b/docs/docs/api/appkit-ui/functions/DropdownMenuTrigger.md new file mode 100644 index 0000000..1c5ab48 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/DropdownMenuTrigger.md @@ -0,0 +1,17 @@ +# Function: DropdownMenuTrigger() + +```ts +function DropdownMenuTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/dropdown-menu.tsx:21](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/dropdown-menu.tsx#L21) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DropdownMenuTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Empty.md b/docs/docs/api/appkit-ui/functions/Empty.md new file mode 100644 index 0000000..e3860f6 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Empty.md @@ -0,0 +1,17 @@ +# Function: Empty() + +```ts +function Empty(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/empty.tsx:5](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/empty.tsx#L5) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/EmptyContent.md b/docs/docs/api/appkit-ui/functions/EmptyContent.md new file mode 100644 index 0000000..09bdb0c --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/EmptyContent.md @@ -0,0 +1,17 @@ +# Function: EmptyContent() + +```ts +function EmptyContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/empty.tsx:84](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/empty.tsx#L84) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/EmptyDescription.md b/docs/docs/api/appkit-ui/functions/EmptyDescription.md new file mode 100644 index 0000000..51aecc7 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/EmptyDescription.md @@ -0,0 +1,17 @@ +# Function: EmptyDescription() + +```ts +function EmptyDescription(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/empty.tsx:71](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/empty.tsx#L71) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLParagraphElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/EmptyHeader.md b/docs/docs/api/appkit-ui/functions/EmptyHeader.md new file mode 100644 index 0000000..8143cd4 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/EmptyHeader.md @@ -0,0 +1,17 @@ +# Function: EmptyHeader() + +```ts +function EmptyHeader(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/empty.tsx:18](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/empty.tsx#L18) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/EmptyMedia.md b/docs/docs/api/appkit-ui/functions/EmptyMedia.md new file mode 100644 index 0000000..7b39ca8 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/EmptyMedia.md @@ -0,0 +1,17 @@ +# Function: EmptyMedia() + +```ts +function EmptyMedia(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/empty.tsx:46](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/empty.tsx#L46) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `VariantProps`\<(`props?`) => `string`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/EmptyTitle.md b/docs/docs/api/appkit-ui/functions/EmptyTitle.md new file mode 100644 index 0000000..c945725 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/EmptyTitle.md @@ -0,0 +1,17 @@ +# Function: EmptyTitle() + +```ts +function EmptyTitle(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/empty.tsx:61](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/empty.tsx#L61) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Field.md b/docs/docs/api/appkit-ui/functions/Field.md new file mode 100644 index 0000000..c97c907 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Field.md @@ -0,0 +1,17 @@ +# Function: Field() + +```ts +function Field(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/field.tsx:79](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx#L79) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `VariantProps`\<(`props?`) => `string`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FieldContent.md b/docs/docs/api/appkit-ui/functions/FieldContent.md new file mode 100644 index 0000000..7062c04 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FieldContent.md @@ -0,0 +1,17 @@ +# Function: FieldContent() + +```ts +function FieldContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/field.tsx:95](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx#L95) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FieldDescription.md b/docs/docs/api/appkit-ui/functions/FieldDescription.md new file mode 100644 index 0000000..b462f48 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FieldDescription.md @@ -0,0 +1,17 @@ +# Function: FieldDescription() + +```ts +function FieldDescription(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/field.tsx:139](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx#L139) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLParagraphElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FieldError.md b/docs/docs/api/appkit-ui/functions/FieldError.md new file mode 100644 index 0000000..a99217b --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FieldError.md @@ -0,0 +1,17 @@ +# Function: FieldError() + +```ts +function FieldError(__namedParameters): Element | null; +``` + +Defined in: [packages/appkit-ui/src/react/ui/field.tsx:184](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx#L184) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` \| `null` diff --git a/docs/docs/api/appkit-ui/functions/FieldGroup.md b/docs/docs/api/appkit-ui/functions/FieldGroup.md new file mode 100644 index 0000000..d062c76 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FieldGroup.md @@ -0,0 +1,17 @@ +# Function: FieldGroup() + +```ts +function FieldGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/field.tsx:42](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx#L42) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FieldLabel.md b/docs/docs/api/appkit-ui/functions/FieldLabel.md new file mode 100644 index 0000000..4a72303 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FieldLabel.md @@ -0,0 +1,17 @@ +# Function: FieldLabel() + +```ts +function FieldLabel(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/field.tsx:108](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx#L108) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `LabelProps` & `RefAttributes`\<`HTMLLabelElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FieldLegend.md b/docs/docs/api/appkit-ui/functions/FieldLegend.md new file mode 100644 index 0000000..ede80e6 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FieldLegend.md @@ -0,0 +1,17 @@ +# Function: FieldLegend() + +```ts +function FieldLegend(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/field.tsx:22](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx#L22) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLLegendElement`\> & `HTMLAttributes`\<`HTMLLegendElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FieldSeparator.md b/docs/docs/api/appkit-ui/functions/FieldSeparator.md new file mode 100644 index 0000000..5660b1a --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FieldSeparator.md @@ -0,0 +1,17 @@ +# Function: FieldSeparator() + +```ts +function FieldSeparator(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/field.tsx:154](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx#L154) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FieldSet.md b/docs/docs/api/appkit-ui/functions/FieldSet.md new file mode 100644 index 0000000..f5ef983 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FieldSet.md @@ -0,0 +1,17 @@ +# Function: FieldSet() + +```ts +function FieldSet(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/field.tsx:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx#L8) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`FieldsetHTMLAttributes`\<`HTMLFieldSetElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FieldTitle.md b/docs/docs/api/appkit-ui/functions/FieldTitle.md new file mode 100644 index 0000000..1dc1768 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FieldTitle.md @@ -0,0 +1,17 @@ +# Function: FieldTitle() + +```ts +function FieldTitle(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/field.tsx:126](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/field.tsx#L126) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FormControl.md b/docs/docs/api/appkit-ui/functions/FormControl.md new file mode 100644 index 0000000..0f66bb3 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FormControl.md @@ -0,0 +1,17 @@ +# Function: FormControl() + +```ts +function FormControl(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/form.tsx:107](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx#L107) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SlotProps` & `RefAttributes`\<`HTMLElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FormDescription.md b/docs/docs/api/appkit-ui/functions/FormDescription.md new file mode 100644 index 0000000..3a7a0bf --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FormDescription.md @@ -0,0 +1,17 @@ +# Function: FormDescription() + +```ts +function FormDescription(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/form.tsx:126](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx#L126) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLParagraphElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FormField.md b/docs/docs/api/appkit-ui/functions/FormField.md new file mode 100644 index 0000000..e28c50e --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FormField.md @@ -0,0 +1,24 @@ +# Function: FormField() + +```ts +function FormField(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/form.tsx:32](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx#L32) + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `TFieldValues` *extends* `FieldValues` | `FieldValues` | +| `TName` *extends* `string` | `FieldPath`\<`TFieldValues`\> | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ControllerProps`\<`TFieldValues`, `TName`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FormItem.md b/docs/docs/api/appkit-ui/functions/FormItem.md new file mode 100644 index 0000000..1e16997 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FormItem.md @@ -0,0 +1,17 @@ +# Function: FormItem() + +```ts +function FormItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/form.tsx:76](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx#L76) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FormLabel.md b/docs/docs/api/appkit-ui/functions/FormLabel.md new file mode 100644 index 0000000..7a69f24 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FormLabel.md @@ -0,0 +1,17 @@ +# Function: FormLabel() + +```ts +function FormLabel(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/form.tsx:90](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx#L90) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `LabelProps` & `RefAttributes`\<`HTMLLabelElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/FormMessage.md b/docs/docs/api/appkit-ui/functions/FormMessage.md new file mode 100644 index 0000000..e49fca9 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/FormMessage.md @@ -0,0 +1,17 @@ +# Function: FormMessage() + +```ts +function FormMessage(__namedParameters): Element | null; +``` + +Defined in: [packages/appkit-ui/src/react/ui/form.tsx:139](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx#L139) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLParagraphElement`\>\> | + +## Returns + +`Element` \| `null` diff --git a/docs/docs/api/appkit-ui/functions/HoverCard.md b/docs/docs/api/appkit-ui/functions/HoverCard.md new file mode 100644 index 0000000..0e719ee --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/HoverCard.md @@ -0,0 +1,17 @@ +# Function: HoverCard() + +```ts +function HoverCard(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/hover-card.tsx:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/hover-card.tsx#L8) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `HoverCardProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/HoverCardContent.md b/docs/docs/api/appkit-ui/functions/HoverCardContent.md new file mode 100644 index 0000000..c8ce44a --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/HoverCardContent.md @@ -0,0 +1,17 @@ +# Function: HoverCardContent() + +```ts +function HoverCardContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/hover-card.tsx:22](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/hover-card.tsx#L22) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `HoverCardContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/HoverCardTrigger.md b/docs/docs/api/appkit-ui/functions/HoverCardTrigger.md new file mode 100644 index 0000000..73240b2 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/HoverCardTrigger.md @@ -0,0 +1,17 @@ +# Function: HoverCardTrigger() + +```ts +function HoverCardTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/hover-card.tsx:14](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/hover-card.tsx#L14) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `HoverCardTriggerProps` & `RefAttributes`\<`HTMLAnchorElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Input.md b/docs/docs/api/appkit-ui/functions/Input.md new file mode 100644 index 0000000..aa70ffa --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Input.md @@ -0,0 +1,17 @@ +# Function: Input() + +```ts +function Input(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/input.tsx:5](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input.tsx#L5) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`InputHTMLAttributes`\<`HTMLInputElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/InputGroup.md b/docs/docs/api/appkit-ui/functions/InputGroup.md new file mode 100644 index 0000000..2a93fd7 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/InputGroup.md @@ -0,0 +1,17 @@ +# Function: InputGroup() + +```ts +function InputGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/input-group.tsx:11](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-group.tsx#L11) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/InputGroupAddon.md b/docs/docs/api/appkit-ui/functions/InputGroupAddon.md new file mode 100644 index 0000000..d2afad4 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/InputGroupAddon.md @@ -0,0 +1,17 @@ +# Function: InputGroupAddon() + +```ts +function InputGroupAddon(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/input-group.tsx:60](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-group.tsx#L60) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `VariantProps`\<(`props?`) => `string`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/InputGroupButton.md b/docs/docs/api/appkit-ui/functions/InputGroupButton.md new file mode 100644 index 0000000..6310a71 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/InputGroupButton.md @@ -0,0 +1,17 @@ +# Function: InputGroupButton() + +```ts +function InputGroupButton(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/input-group.tsx:100](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-group.tsx#L100) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `Omit`\<`ClassAttributes`\<`HTMLButtonElement`\> & `ButtonHTMLAttributes`\<`HTMLButtonElement`\> & `VariantProps`\<(`props?`) => `string`\> & `object`, `"size"`\> & `VariantProps`\<(`props?`) => `string`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/InputGroupInput.md b/docs/docs/api/appkit-ui/functions/InputGroupInput.md new file mode 100644 index 0000000..5ab405c --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/InputGroupInput.md @@ -0,0 +1,17 @@ +# Function: InputGroupInput() + +```ts +function InputGroupInput(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/input-group.tsx:131](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-group.tsx#L131) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`InputHTMLAttributes`\<`HTMLInputElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/InputGroupText.md b/docs/docs/api/appkit-ui/functions/InputGroupText.md new file mode 100644 index 0000000..e576de8 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/InputGroupText.md @@ -0,0 +1,17 @@ +# Function: InputGroupText() + +```ts +function InputGroupText(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/input-group.tsx:119](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-group.tsx#L119) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLSpanElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/InputGroupTextarea.md b/docs/docs/api/appkit-ui/functions/InputGroupTextarea.md new file mode 100644 index 0000000..3f3336f --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/InputGroupTextarea.md @@ -0,0 +1,17 @@ +# Function: InputGroupTextarea() + +```ts +function InputGroupTextarea(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/input-group.tsx:147](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-group.tsx#L147) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`TextareaHTMLAttributes`\<`HTMLTextAreaElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/InputOTP.md b/docs/docs/api/appkit-ui/functions/InputOTP.md new file mode 100644 index 0000000..6aa7573 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/InputOTP.md @@ -0,0 +1,17 @@ +# Function: InputOTP() + +```ts +function InputOTP(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/input-otp.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-otp.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | OTPInputProps & RefAttributes\ & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/InputOTPGroup.md b/docs/docs/api/appkit-ui/functions/InputOTPGroup.md new file mode 100644 index 0000000..0d42fb9 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/InputOTPGroup.md @@ -0,0 +1,17 @@ +# Function: InputOTPGroup() + +```ts +function InputOTPGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/input-otp.tsx:27](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-otp.tsx#L27) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/InputOTPSeparator.md b/docs/docs/api/appkit-ui/functions/InputOTPSeparator.md new file mode 100644 index 0000000..0ec7b73 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/InputOTPSeparator.md @@ -0,0 +1,17 @@ +# Function: InputOTPSeparator() + +```ts +function InputOTPSeparator(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/input-otp.tsx:67](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-otp.tsx#L67) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/InputOTPSlot.md b/docs/docs/api/appkit-ui/functions/InputOTPSlot.md new file mode 100644 index 0000000..a00fc61 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/InputOTPSlot.md @@ -0,0 +1,17 @@ +# Function: InputOTPSlot() + +```ts +function InputOTPSlot(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/input-otp.tsx:37](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/input-otp.tsx#L37) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Item.md b/docs/docs/api/appkit-ui/functions/Item.md new file mode 100644 index 0000000..d5bc4c3 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Item.md @@ -0,0 +1,17 @@ +# Function: Item() + +```ts +function Item(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/item.tsx:54](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/item.tsx#L54) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `VariantProps`\<(`props?`) => `string`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ItemActions.md b/docs/docs/api/appkit-ui/functions/ItemActions.md new file mode 100644 index 0000000..b5223d8 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ItemActions.md @@ -0,0 +1,17 @@ +# Function: ItemActions() + +```ts +function ItemActions(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/item.tsx:146](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/item.tsx#L146) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ItemContent.md b/docs/docs/api/appkit-ui/functions/ItemContent.md new file mode 100644 index 0000000..4f55162 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ItemContent.md @@ -0,0 +1,17 @@ +# Function: ItemContent() + +```ts +function ItemContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/item.tsx:106](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/item.tsx#L106) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ItemDescription.md b/docs/docs/api/appkit-ui/functions/ItemDescription.md new file mode 100644 index 0000000..8da8881 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ItemDescription.md @@ -0,0 +1,17 @@ +# Function: ItemDescription() + +```ts +function ItemDescription(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/item.tsx:132](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/item.tsx#L132) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLParagraphElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ItemFooter.md b/docs/docs/api/appkit-ui/functions/ItemFooter.md new file mode 100644 index 0000000..10c7e0f --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ItemFooter.md @@ -0,0 +1,17 @@ +# Function: ItemFooter() + +```ts +function ItemFooter(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/item.tsx:169](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/item.tsx#L169) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ItemGroup.md b/docs/docs/api/appkit-ui/functions/ItemGroup.md new file mode 100644 index 0000000..9fe241f --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ItemGroup.md @@ -0,0 +1,17 @@ +# Function: ItemGroup() + +```ts +function ItemGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/item.tsx:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/item.tsx#L8) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ItemHeader.md b/docs/docs/api/appkit-ui/functions/ItemHeader.md new file mode 100644 index 0000000..0614bb6 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ItemHeader.md @@ -0,0 +1,17 @@ +# Function: ItemHeader() + +```ts +function ItemHeader(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/item.tsx:156](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/item.tsx#L156) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ItemMedia.md b/docs/docs/api/appkit-ui/functions/ItemMedia.md new file mode 100644 index 0000000..7b86d81 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ItemMedia.md @@ -0,0 +1,17 @@ +# Function: ItemMedia() + +```ts +function ItemMedia(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/item.tsx:91](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/item.tsx#L91) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `VariantProps`\<(`props?`) => `string`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ItemSeparator.md b/docs/docs/api/appkit-ui/functions/ItemSeparator.md new file mode 100644 index 0000000..539ed6b --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ItemSeparator.md @@ -0,0 +1,17 @@ +# Function: ItemSeparator() + +```ts +function ItemSeparator(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/item.tsx:19](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/item.tsx#L19) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SeparatorProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ItemTitle.md b/docs/docs/api/appkit-ui/functions/ItemTitle.md new file mode 100644 index 0000000..3e94145 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ItemTitle.md @@ -0,0 +1,17 @@ +# Function: ItemTitle() + +```ts +function ItemTitle(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/item.tsx:119](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/item.tsx#L119) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Kbd.md b/docs/docs/api/appkit-ui/functions/Kbd.md new file mode 100644 index 0000000..49223f0 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Kbd.md @@ -0,0 +1,17 @@ +# Function: Kbd() + +```ts +function Kbd(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/kbd.tsx:3](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/kbd.tsx#L3) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/KbdGroup.md b/docs/docs/api/appkit-ui/functions/KbdGroup.md new file mode 100644 index 0000000..eeb6ceb --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/KbdGroup.md @@ -0,0 +1,17 @@ +# Function: KbdGroup() + +```ts +function KbdGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/kbd.tsx:18](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/kbd.tsx#L18) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Label.md b/docs/docs/api/appkit-ui/functions/Label.md new file mode 100644 index 0000000..c752c35 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Label.md @@ -0,0 +1,17 @@ +# Function: Label() + +```ts +function Label(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/label.tsx:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/label.tsx#L8) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `LabelProps` & `RefAttributes`\<`HTMLLabelElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Menubar.md b/docs/docs/api/appkit-ui/functions/Menubar.md new file mode 100644 index 0000000..1dceea9 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Menubar.md @@ -0,0 +1,17 @@ +# Function: Menubar() + +```ts +function Menubar(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarCheckboxItem.md b/docs/docs/api/appkit-ui/functions/MenubarCheckboxItem.md new file mode 100644 index 0000000..210afae --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarCheckboxItem.md @@ -0,0 +1,17 @@ +# Function: MenubarCheckboxItem() + +```ts +function MenubarCheckboxItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:112](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L112) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarCheckboxItemProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarContent.md b/docs/docs/api/appkit-ui/functions/MenubarContent.md new file mode 100644 index 0000000..94c6841 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarContent.md @@ -0,0 +1,17 @@ +# Function: MenubarContent() + +```ts +function MenubarContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:65](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L65) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarGroup.md b/docs/docs/api/appkit-ui/functions/MenubarGroup.md new file mode 100644 index 0000000..ff28fed --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarGroup.md @@ -0,0 +1,17 @@ +# Function: MenubarGroup() + +```ts +function MenubarGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:29](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L29) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarGroupProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarItem.md b/docs/docs/api/appkit-ui/functions/MenubarItem.md new file mode 100644 index 0000000..4db8684 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarItem.md @@ -0,0 +1,17 @@ +# Function: MenubarItem() + +```ts +function MenubarItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:89](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L89) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarItemProps` & `RefAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarLabel.md b/docs/docs/api/appkit-ui/functions/MenubarLabel.md new file mode 100644 index 0000000..3f676e2 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarLabel.md @@ -0,0 +1,17 @@ +# Function: MenubarLabel() + +```ts +function MenubarLabel(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:162](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L162) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarLabelProps` & `RefAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarMenu.md b/docs/docs/api/appkit-ui/functions/MenubarMenu.md new file mode 100644 index 0000000..470e97d --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarMenu.md @@ -0,0 +1,17 @@ +# Function: MenubarMenu() + +```ts +function MenubarMenu(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:23](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L23) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarMenuProps` & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarPortal.md b/docs/docs/api/appkit-ui/functions/MenubarPortal.md new file mode 100644 index 0000000..21963fa --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarPortal.md @@ -0,0 +1,17 @@ +# Function: MenubarPortal() + +```ts +function MenubarPortal(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:35](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L35) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarPortalProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarRadioGroup.md b/docs/docs/api/appkit-ui/functions/MenubarRadioGroup.md new file mode 100644 index 0000000..353aaa1 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarRadioGroup.md @@ -0,0 +1,17 @@ +# Function: MenubarRadioGroup() + +```ts +function MenubarRadioGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:41](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L41) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarRadioGroupProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarRadioItem.md b/docs/docs/api/appkit-ui/functions/MenubarRadioItem.md new file mode 100644 index 0000000..8513092 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarRadioItem.md @@ -0,0 +1,17 @@ +# Function: MenubarRadioItem() + +```ts +function MenubarRadioItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:138](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L138) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarRadioItemProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarSeparator.md b/docs/docs/api/appkit-ui/functions/MenubarSeparator.md new file mode 100644 index 0000000..639c65e --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarSeparator.md @@ -0,0 +1,17 @@ +# Function: MenubarSeparator() + +```ts +function MenubarSeparator(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:182](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L182) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarSeparatorProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarShortcut.md b/docs/docs/api/appkit-ui/functions/MenubarShortcut.md new file mode 100644 index 0000000..30cb56d --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarShortcut.md @@ -0,0 +1,17 @@ +# Function: MenubarShortcut() + +```ts +function MenubarShortcut(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:195](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L195) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLSpanElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarSub.md b/docs/docs/api/appkit-ui/functions/MenubarSub.md new file mode 100644 index 0000000..d38322e --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarSub.md @@ -0,0 +1,17 @@ +# Function: MenubarSub() + +```ts +function MenubarSub(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:211](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L211) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarSubProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarSubContent.md b/docs/docs/api/appkit-ui/functions/MenubarSubContent.md new file mode 100644 index 0000000..86b266f --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarSubContent.md @@ -0,0 +1,17 @@ +# Function: MenubarSubContent() + +```ts +function MenubarSubContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:241](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L241) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarSubContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarSubTrigger.md b/docs/docs/api/appkit-ui/functions/MenubarSubTrigger.md new file mode 100644 index 0000000..cc6277d --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarSubTrigger.md @@ -0,0 +1,17 @@ +# Function: MenubarSubTrigger() + +```ts +function MenubarSubTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:217](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L217) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarSubTriggerProps` & `RefAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/MenubarTrigger.md b/docs/docs/api/appkit-ui/functions/MenubarTrigger.md new file mode 100644 index 0000000..79338a2 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/MenubarTrigger.md @@ -0,0 +1,17 @@ +# Function: MenubarTrigger() + +```ts +function MenubarTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/menubar.tsx:49](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/menubar.tsx#L49) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `MenubarTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/NavigationMenu.md b/docs/docs/api/appkit-ui/functions/NavigationMenu.md new file mode 100644 index 0000000..b11575c --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/NavigationMenu.md @@ -0,0 +1,17 @@ +# Function: NavigationMenu() + +```ts +function NavigationMenu(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/navigation-menu.tsx:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx#L8) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `NavigationMenuProps` & `RefAttributes`\<`HTMLElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/NavigationMenuContent.md b/docs/docs/api/appkit-ui/functions/NavigationMenuContent.md new file mode 100644 index 0000000..a07deb1 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/NavigationMenuContent.md @@ -0,0 +1,17 @@ +# Function: NavigationMenuContent() + +```ts +function NavigationMenuContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/navigation-menu.tsx:85](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx#L85) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `NavigationMenuContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/NavigationMenuIndicator.md b/docs/docs/api/appkit-ui/functions/NavigationMenuIndicator.md new file mode 100644 index 0000000..b917e93 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/NavigationMenuIndicator.md @@ -0,0 +1,17 @@ +# Function: NavigationMenuIndicator() + +```ts +function NavigationMenuIndicator(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/navigation-menu.tsx:140](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx#L140) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `NavigationMenuIndicatorProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/NavigationMenuItem.md b/docs/docs/api/appkit-ui/functions/NavigationMenuItem.md new file mode 100644 index 0000000..1c8afb6 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/NavigationMenuItem.md @@ -0,0 +1,17 @@ +# Function: NavigationMenuItem() + +```ts +function NavigationMenuItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/navigation-menu.tsx:48](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx#L48) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `NavigationMenuItemProps` & `RefAttributes`\<`HTMLLIElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/NavigationMenuLink.md b/docs/docs/api/appkit-ui/functions/NavigationMenuLink.md new file mode 100644 index 0000000..af319bb --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/NavigationMenuLink.md @@ -0,0 +1,17 @@ +# Function: NavigationMenuLink() + +```ts +function NavigationMenuLink(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/navigation-menu.tsx:124](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx#L124) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `NavigationMenuLinkProps` & `RefAttributes`\<`HTMLAnchorElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/NavigationMenuList.md b/docs/docs/api/appkit-ui/functions/NavigationMenuList.md new file mode 100644 index 0000000..add77ee --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/NavigationMenuList.md @@ -0,0 +1,17 @@ +# Function: NavigationMenuList() + +```ts +function NavigationMenuList(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/navigation-menu.tsx:32](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx#L32) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `NavigationMenuListProps` & `RefAttributes`\<`HTMLUListElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/NavigationMenuTrigger.md b/docs/docs/api/appkit-ui/functions/NavigationMenuTrigger.md new file mode 100644 index 0000000..e230367 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/NavigationMenuTrigger.md @@ -0,0 +1,17 @@ +# Function: NavigationMenuTrigger() + +```ts +function NavigationMenuTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/navigation-menu.tsx:65](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx#L65) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `NavigationMenuTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/NavigationMenuViewport.md b/docs/docs/api/appkit-ui/functions/NavigationMenuViewport.md new file mode 100644 index 0000000..e633861 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/NavigationMenuViewport.md @@ -0,0 +1,17 @@ +# Function: NavigationMenuViewport() + +```ts +function NavigationMenuViewport(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/navigation-menu.tsx:102](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx#L102) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `NavigationMenuViewportProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Pagination.md b/docs/docs/api/appkit-ui/functions/Pagination.md new file mode 100644 index 0000000..1f41e87 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Pagination.md @@ -0,0 +1,17 @@ +# Function: Pagination() + +```ts +function Pagination(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/pagination.tsx:11](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx#L11) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/PaginationContent.md b/docs/docs/api/appkit-ui/functions/PaginationContent.md new file mode 100644 index 0000000..7798647 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/PaginationContent.md @@ -0,0 +1,17 @@ +# Function: PaginationContent() + +```ts +function PaginationContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/pagination.tsx:23](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx#L23) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLUListElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/PaginationEllipsis.md b/docs/docs/api/appkit-ui/functions/PaginationEllipsis.md new file mode 100644 index 0000000..25818cc --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/PaginationEllipsis.md @@ -0,0 +1,17 @@ +# Function: PaginationEllipsis() + +```ts +function PaginationEllipsis(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/pagination.tsx:102](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx#L102) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLSpanElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/PaginationItem.md b/docs/docs/api/appkit-ui/functions/PaginationItem.md new file mode 100644 index 0000000..c7374fe --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/PaginationItem.md @@ -0,0 +1,17 @@ +# Function: PaginationItem() + +```ts +function PaginationItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/pagination.tsx:36](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx#L36) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`LiHTMLAttributes`\<`HTMLLIElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/PaginationLink.md b/docs/docs/api/appkit-ui/functions/PaginationLink.md new file mode 100644 index 0000000..588a769 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/PaginationLink.md @@ -0,0 +1,17 @@ +# Function: PaginationLink() + +```ts +function PaginationLink(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/pagination.tsx:45](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx#L45) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `PaginationLinkProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/PaginationNext.md b/docs/docs/api/appkit-ui/functions/PaginationNext.md new file mode 100644 index 0000000..481c51f --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/PaginationNext.md @@ -0,0 +1,17 @@ +# Function: PaginationNext() + +```ts +function PaginationNext(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/pagination.tsx:85](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx#L85) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `object` & `Pick`\<`ClassAttributes`\<`HTMLButtonElement`\> & `ButtonHTMLAttributes`\<`HTMLButtonElement`\> & `VariantProps`\<(`props?`) => `string`\> & `object`, `"size"`\> & `ClassAttributes`\<`HTMLAnchorElement`\> & `AnchorHTMLAttributes`\<`HTMLAnchorElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/PaginationPrevious.md b/docs/docs/api/appkit-ui/functions/PaginationPrevious.md new file mode 100644 index 0000000..a3ee0cf --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/PaginationPrevious.md @@ -0,0 +1,17 @@ +# Function: PaginationPrevious() + +```ts +function PaginationPrevious(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/pagination.tsx:68](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/pagination.tsx#L68) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `object` & `Pick`\<`ClassAttributes`\<`HTMLButtonElement`\> & `ButtonHTMLAttributes`\<`HTMLButtonElement`\> & `VariantProps`\<(`props?`) => `string`\> & `object`, `"size"`\> & `ClassAttributes`\<`HTMLAnchorElement`\> & `AnchorHTMLAttributes`\<`HTMLAnchorElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Popover.md b/docs/docs/api/appkit-ui/functions/Popover.md new file mode 100644 index 0000000..3662aa0 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Popover.md @@ -0,0 +1,17 @@ +# Function: Popover() + +```ts +function Popover(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/popover.tsx:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/popover.tsx#L8) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `PopoverProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/PopoverAnchor.md b/docs/docs/api/appkit-ui/functions/PopoverAnchor.md new file mode 100644 index 0000000..7f5eb76 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/PopoverAnchor.md @@ -0,0 +1,17 @@ +# Function: PopoverAnchor() + +```ts +function PopoverAnchor(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/popover.tsx:42](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/popover.tsx#L42) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `PopoverAnchorProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/PopoverContent.md b/docs/docs/api/appkit-ui/functions/PopoverContent.md new file mode 100644 index 0000000..e040e43 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/PopoverContent.md @@ -0,0 +1,17 @@ +# Function: PopoverContent() + +```ts +function PopoverContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/popover.tsx:20](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/popover.tsx#L20) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `PopoverContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/PopoverTrigger.md b/docs/docs/api/appkit-ui/functions/PopoverTrigger.md new file mode 100644 index 0000000..9f400df --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/PopoverTrigger.md @@ -0,0 +1,17 @@ +# Function: PopoverTrigger() + +```ts +function PopoverTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/popover.tsx:14](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/popover.tsx#L14) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `PopoverTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Progress.md b/docs/docs/api/appkit-ui/functions/Progress.md new file mode 100644 index 0000000..b582ad7 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Progress.md @@ -0,0 +1,17 @@ +# Function: Progress() + +```ts +function Progress(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/progress.tsx:6](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/progress.tsx#L6) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ProgressProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/RadioGroup.md b/docs/docs/api/appkit-ui/functions/RadioGroup.md new file mode 100644 index 0000000..9a61c5c --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/RadioGroup.md @@ -0,0 +1,17 @@ +# Function: RadioGroup() + +```ts +function RadioGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/radio-group.tsx:9](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/radio-group.tsx#L9) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `RadioGroupProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/RadioGroupItem.md b/docs/docs/api/appkit-ui/functions/RadioGroupItem.md new file mode 100644 index 0000000..94950f9 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/RadioGroupItem.md @@ -0,0 +1,17 @@ +# Function: RadioGroupItem() + +```ts +function RadioGroupItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/radio-group.tsx:22](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/radio-group.tsx#L22) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `RadioGroupItemProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ResizableHandle.md b/docs/docs/api/appkit-ui/functions/ResizableHandle.md new file mode 100644 index 0000000..2f3f4b6 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ResizableHandle.md @@ -0,0 +1,17 @@ +# Function: ResizableHandle() + +```ts +function ResizableHandle(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/resizable.tsx:29](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/resizable.tsx#L29) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `Omit`\<`HTMLAttributes`\, `"id"` \| `"onFocus"` \| `"onBlur"` \| `"onClick"` \| `"onPointerDown"` \| `"onPointerUp"`\> & `object` & `object` & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ResizablePanel.md b/docs/docs/api/appkit-ui/functions/ResizablePanel.md new file mode 100644 index 0000000..2db8d9a --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ResizablePanel.md @@ -0,0 +1,17 @@ +# Function: ResizablePanel() + +```ts +function ResizablePanel(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/resizable.tsx:23](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/resizable.tsx#L23) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `Omit`\<`HTMLAttributes`\< \| `HTMLElement` \| `HTMLDivElement` \| `HTMLParagraphElement` \| `HTMLButtonElement` \| `HTMLSpanElement` \| `HTMLInputElement` \| `HTMLTableElement` \| `HTMLTableSectionElement` \| `HTMLTableRowElement` \| `HTMLTableCellElement` \| `HTMLHeadingElement` \| `HTMLImageElement` \| `HTMLOListElement` \| `HTMLLIElement` \| `HTMLAnchorElement` \| `HTMLStyleElement` \| `HTMLLabelElement` \| `HTMLFieldSetElement` \| `HTMLLegendElement` \| `HTMLUListElement` \| `HTMLSelectElement` \| `HTMLTextAreaElement` \| `HTMLObjectElement` \| `HTMLAreaElement` \| `HTMLAudioElement` \| `HTMLBaseElement` \| `HTMLQuoteElement` \| `HTMLBodyElement` \| `HTMLBRElement` \| `HTMLCanvasElement` \| `HTMLTableCaptionElement` \| `HTMLTableColElement` \| `HTMLDataElement` \| `HTMLDataListElement` \| `HTMLModElement` \| `HTMLDetailsElement` \| `HTMLDialogElement` \| `HTMLDListElement` \| `HTMLEmbedElement` \| `HTMLFormElement` \| `HTMLHeadElement` \| `HTMLHRElement` \| `HTMLHtmlElement` \| `HTMLIFrameElement` \| `HTMLLinkElement` \| `HTMLMapElement` \| `HTMLMenuElement` \| `HTMLMetaElement` \| `HTMLMeterElement` \| `HTMLOptGroupElement` \| `HTMLOptionElement` \| `HTMLOutputElement` \| `HTMLPictureElement` \| `HTMLPreElement` \| `HTMLProgressElement` \| `HTMLScriptElement` \| `HTMLSlotElement` \| `HTMLSourceElement` \| `HTMLTemplateElement` \| `HTMLTimeElement` \| `HTMLTitleElement` \| `HTMLTrackElement` \| `HTMLVideoElement`\>, `"id"` \| `"onResize"`\> & `object` & `object` & `RefAttributes`\<`ImperativePanelHandle`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ResizablePanelGroup.md b/docs/docs/api/appkit-ui/functions/ResizablePanelGroup.md new file mode 100644 index 0000000..97a77a9 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ResizablePanelGroup.md @@ -0,0 +1,17 @@ +# Function: ResizablePanelGroup() + +```ts +function ResizablePanelGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/resizable.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/resizable.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `Omit`\<`HTMLAttributes`\, `"id"`\> & `object` & `object` & `RefAttributes`\<`ImperativePanelGroupHandle`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ScrollArea.md b/docs/docs/api/appkit-ui/functions/ScrollArea.md new file mode 100644 index 0000000..e0d2043 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ScrollArea.md @@ -0,0 +1,17 @@ +# Function: ScrollArea() + +```ts +function ScrollArea(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/scroll-area.tsx:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/scroll-area.tsx#L8) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ScrollAreaProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ScrollBar.md b/docs/docs/api/appkit-ui/functions/ScrollBar.md new file mode 100644 index 0000000..3d35060 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ScrollBar.md @@ -0,0 +1,17 @@ +# Function: ScrollBar() + +```ts +function ScrollBar(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/scroll-area.tsx:31](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/scroll-area.tsx#L31) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ScrollAreaScrollbarProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Select.md b/docs/docs/api/appkit-ui/functions/Select.md new file mode 100644 index 0000000..7acd55d --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Select.md @@ -0,0 +1,17 @@ +# Function: Select() + +```ts +function Select(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/select.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/select.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SelectSharedProps` & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SelectContent.md b/docs/docs/api/appkit-ui/functions/SelectContent.md new file mode 100644 index 0000000..5a0ab2c --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SelectContent.md @@ -0,0 +1,17 @@ +# Function: SelectContent() + +```ts +function SelectContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/select.tsx:51](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/select.tsx#L51) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SelectContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SelectGroup.md b/docs/docs/api/appkit-ui/functions/SelectGroup.md new file mode 100644 index 0000000..c3f1f24 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SelectGroup.md @@ -0,0 +1,17 @@ +# Function: SelectGroup() + +```ts +function SelectGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/select.tsx:13](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/select.tsx#L13) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SelectGroupProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SelectItem.md b/docs/docs/api/appkit-ui/functions/SelectItem.md new file mode 100644 index 0000000..fcf7147 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SelectItem.md @@ -0,0 +1,17 @@ +# Function: SelectItem() + +```ts +function SelectItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/select.tsx:101](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/select.tsx#L101) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SelectItemProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SelectLabel.md b/docs/docs/api/appkit-ui/functions/SelectLabel.md new file mode 100644 index 0000000..5915028 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SelectLabel.md @@ -0,0 +1,17 @@ +# Function: SelectLabel() + +```ts +function SelectLabel(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/select.tsx:88](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/select.tsx#L88) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SelectLabelProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SelectScrollDownButton.md b/docs/docs/api/appkit-ui/functions/SelectScrollDownButton.md new file mode 100644 index 0000000..031c59d --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SelectScrollDownButton.md @@ -0,0 +1,17 @@ +# Function: SelectScrollDownButton() + +```ts +function SelectScrollDownButton(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/select.tsx:156](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/select.tsx#L156) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SelectScrollDownButtonProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SelectScrollUpButton.md b/docs/docs/api/appkit-ui/functions/SelectScrollUpButton.md new file mode 100644 index 0000000..9b10986 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SelectScrollUpButton.md @@ -0,0 +1,17 @@ +# Function: SelectScrollUpButton() + +```ts +function SelectScrollUpButton(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/select.tsx:138](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/select.tsx#L138) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SelectScrollUpButtonProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SelectSeparator.md b/docs/docs/api/appkit-ui/functions/SelectSeparator.md new file mode 100644 index 0000000..8e35758 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SelectSeparator.md @@ -0,0 +1,17 @@ +# Function: SelectSeparator() + +```ts +function SelectSeparator(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/select.tsx:125](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/select.tsx#L125) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SelectSeparatorProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SelectTrigger.md b/docs/docs/api/appkit-ui/functions/SelectTrigger.md new file mode 100644 index 0000000..43cb05f --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SelectTrigger.md @@ -0,0 +1,17 @@ +# Function: SelectTrigger() + +```ts +function SelectTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/select.tsx:25](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/select.tsx#L25) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SelectTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SelectValue.md b/docs/docs/api/appkit-ui/functions/SelectValue.md new file mode 100644 index 0000000..c577c85 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SelectValue.md @@ -0,0 +1,17 @@ +# Function: SelectValue() + +```ts +function SelectValue(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/select.tsx:19](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/select.tsx#L19) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SelectValueProps` & `RefAttributes`\<`HTMLSpanElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Separator.md b/docs/docs/api/appkit-ui/functions/Separator.md new file mode 100644 index 0000000..7b90dcf --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Separator.md @@ -0,0 +1,17 @@ +# Function: Separator() + +```ts +function Separator(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/separator.tsx:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/separator.tsx#L8) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SeparatorProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Sheet.md b/docs/docs/api/appkit-ui/functions/Sheet.md new file mode 100644 index 0000000..719d721 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Sheet.md @@ -0,0 +1,17 @@ +# Function: Sheet() + +```ts +function Sheet(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sheet.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SheetClose.md b/docs/docs/api/appkit-ui/functions/SheetClose.md new file mode 100644 index 0000000..873b59c --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SheetClose.md @@ -0,0 +1,17 @@ +# Function: SheetClose() + +```ts +function SheetClose(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sheet.tsx:17](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx#L17) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogCloseProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SheetContent.md b/docs/docs/api/appkit-ui/functions/SheetContent.md new file mode 100644 index 0000000..30504cf --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SheetContent.md @@ -0,0 +1,17 @@ +# Function: SheetContent() + +```ts +function SheetContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sheet.tsx:45](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx#L45) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogContentProps` & `RefAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SheetDescription.md b/docs/docs/api/appkit-ui/functions/SheetDescription.md new file mode 100644 index 0000000..5aa0b6a --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SheetDescription.md @@ -0,0 +1,17 @@ +# Function: SheetDescription() + +```ts +function SheetDescription(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sheet.tsx:115](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx#L115) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogDescriptionProps` & `RefAttributes`\<`HTMLParagraphElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SheetFooter.md b/docs/docs/api/appkit-ui/functions/SheetFooter.md new file mode 100644 index 0000000..b67cd7b --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SheetFooter.md @@ -0,0 +1,17 @@ +# Function: SheetFooter() + +```ts +function SheetFooter(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sheet.tsx:92](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx#L92) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SheetHeader.md b/docs/docs/api/appkit-ui/functions/SheetHeader.md new file mode 100644 index 0000000..dcce674 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SheetHeader.md @@ -0,0 +1,17 @@ +# Function: SheetHeader() + +```ts +function SheetHeader(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sheet.tsx:82](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx#L82) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SheetTitle.md b/docs/docs/api/appkit-ui/functions/SheetTitle.md new file mode 100644 index 0000000..e94e819 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SheetTitle.md @@ -0,0 +1,17 @@ +# Function: SheetTitle() + +```ts +function SheetTitle(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sheet.tsx:102](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx#L102) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogTitleProps` & `RefAttributes`\<`HTMLHeadingElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SheetTrigger.md b/docs/docs/api/appkit-ui/functions/SheetTrigger.md new file mode 100644 index 0000000..abe2cc9 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SheetTrigger.md @@ -0,0 +1,17 @@ +# Function: SheetTrigger() + +```ts +function SheetTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sheet.tsx:11](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sheet.tsx#L11) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DialogTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Sidebar.md b/docs/docs/api/appkit-ui/functions/Sidebar.md new file mode 100644 index 0000000..a0461f3 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Sidebar.md @@ -0,0 +1,17 @@ +# Function: Sidebar() + +```ts +function Sidebar(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:154](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L154) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarContent.md b/docs/docs/api/appkit-ui/functions/SidebarContent.md new file mode 100644 index 0000000..55bc579 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarContent.md @@ -0,0 +1,17 @@ +# Function: SidebarContent() + +```ts +function SidebarContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:371](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L371) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarFooter.md b/docs/docs/api/appkit-ui/functions/SidebarFooter.md new file mode 100644 index 0000000..3fdd13e --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarFooter.md @@ -0,0 +1,17 @@ +# Function: SidebarFooter() + +```ts +function SidebarFooter(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:346](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L346) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarGroup.md b/docs/docs/api/appkit-ui/functions/SidebarGroup.md new file mode 100644 index 0000000..5c8fa49 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarGroup.md @@ -0,0 +1,17 @@ +# Function: SidebarGroup() + +```ts +function SidebarGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:385](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L385) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarGroupAction.md b/docs/docs/api/appkit-ui/functions/SidebarGroupAction.md new file mode 100644 index 0000000..0d69a9d --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarGroupAction.md @@ -0,0 +1,17 @@ +# Function: SidebarGroupAction() + +```ts +function SidebarGroupAction(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:417](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L417) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLButtonElement`\> & `ButtonHTMLAttributes`\<`HTMLButtonElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarGroupContent.md b/docs/docs/api/appkit-ui/functions/SidebarGroupContent.md new file mode 100644 index 0000000..576ca0e --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarGroupContent.md @@ -0,0 +1,17 @@ +# Function: SidebarGroupContent() + +```ts +function SidebarGroupContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:440](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L440) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarGroupLabel.md b/docs/docs/api/appkit-ui/functions/SidebarGroupLabel.md new file mode 100644 index 0000000..3832252 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarGroupLabel.md @@ -0,0 +1,17 @@ +# Function: SidebarGroupLabel() + +```ts +function SidebarGroupLabel(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:396](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L396) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarHeader.md b/docs/docs/api/appkit-ui/functions/SidebarHeader.md new file mode 100644 index 0000000..effcbd5 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarHeader.md @@ -0,0 +1,17 @@ +# Function: SidebarHeader() + +```ts +function SidebarHeader(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:335](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L335) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarInput.md b/docs/docs/api/appkit-ui/functions/SidebarInput.md new file mode 100644 index 0000000..c9ceebd --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarInput.md @@ -0,0 +1,17 @@ +# Function: SidebarInput() + +```ts +function SidebarInput(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:321](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L321) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLInputElement`\> & `InputHTMLAttributes`\<`HTMLInputElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarInset.md b/docs/docs/api/appkit-ui/functions/SidebarInset.md new file mode 100644 index 0000000..388e3fc --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarInset.md @@ -0,0 +1,17 @@ +# Function: SidebarInset() + +```ts +function SidebarInset(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:307](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L307) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarMenu.md b/docs/docs/api/appkit-ui/functions/SidebarMenu.md new file mode 100644 index 0000000..c542111 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarMenu.md @@ -0,0 +1,17 @@ +# Function: SidebarMenu() + +```ts +function SidebarMenu(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:454](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L454) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLUListElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarMenuAction.md b/docs/docs/api/appkit-ui/functions/SidebarMenuAction.md new file mode 100644 index 0000000..098b01e --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarMenuAction.md @@ -0,0 +1,17 @@ +# Function: SidebarMenuAction() + +```ts +function SidebarMenuAction(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:548](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L548) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLButtonElement`\> & `ButtonHTMLAttributes`\<`HTMLButtonElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarMenuBadge.md b/docs/docs/api/appkit-ui/functions/SidebarMenuBadge.md new file mode 100644 index 0000000..356bcbf --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarMenuBadge.md @@ -0,0 +1,17 @@ +# Function: SidebarMenuBadge() + +```ts +function SidebarMenuBadge(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:580](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L580) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarMenuButton.md b/docs/docs/api/appkit-ui/functions/SidebarMenuButton.md new file mode 100644 index 0000000..935260b --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarMenuButton.md @@ -0,0 +1,17 @@ +# Function: SidebarMenuButton() + +```ts +function SidebarMenuButton(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:498](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L498) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLButtonElement`\> & `ButtonHTMLAttributes`\<`HTMLButtonElement`\> & `object` & `VariantProps`\<(`props?`) => `string`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarMenuItem.md b/docs/docs/api/appkit-ui/functions/SidebarMenuItem.md new file mode 100644 index 0000000..cb2b373 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarMenuItem.md @@ -0,0 +1,17 @@ +# Function: SidebarMenuItem() + +```ts +function SidebarMenuItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:465](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L465) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`LiHTMLAttributes`\<`HTMLLIElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarMenuSkeleton.md b/docs/docs/api/appkit-ui/functions/SidebarMenuSkeleton.md new file mode 100644 index 0000000..54f1204 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarMenuSkeleton.md @@ -0,0 +1,17 @@ +# Function: SidebarMenuSkeleton() + +```ts +function SidebarMenuSkeleton(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:602](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L602) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarMenuSub.md b/docs/docs/api/appkit-ui/functions/SidebarMenuSub.md new file mode 100644 index 0000000..d7e16b8 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarMenuSub.md @@ -0,0 +1,17 @@ +# Function: SidebarMenuSub() + +```ts +function SidebarMenuSub(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:640](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L640) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLUListElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarMenuSubButton.md b/docs/docs/api/appkit-ui/functions/SidebarMenuSubButton.md new file mode 100644 index 0000000..15404d2 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarMenuSubButton.md @@ -0,0 +1,17 @@ +# Function: SidebarMenuSubButton() + +```ts +function SidebarMenuSubButton(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:669](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L669) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLAnchorElement`\> & `AnchorHTMLAttributes`\<`HTMLAnchorElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarMenuSubItem.md b/docs/docs/api/appkit-ui/functions/SidebarMenuSubItem.md new file mode 100644 index 0000000..252c0e5 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarMenuSubItem.md @@ -0,0 +1,17 @@ +# Function: SidebarMenuSubItem() + +```ts +function SidebarMenuSubItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:655](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L655) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`LiHTMLAttributes`\<`HTMLLIElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarProvider.md b/docs/docs/api/appkit-ui/functions/SidebarProvider.md new file mode 100644 index 0000000..3aacc00 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarProvider.md @@ -0,0 +1,17 @@ +# Function: SidebarProvider() + +```ts +function SidebarProvider(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:56](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L56) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarRail.md b/docs/docs/api/appkit-ui/functions/SidebarRail.md new file mode 100644 index 0000000..0f4460d --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarRail.md @@ -0,0 +1,17 @@ +# Function: SidebarRail() + +```ts +function SidebarRail(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:282](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L282) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`ButtonHTMLAttributes`\<`HTMLButtonElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarSeparator.md b/docs/docs/api/appkit-ui/functions/SidebarSeparator.md new file mode 100644 index 0000000..afde5e6 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarSeparator.md @@ -0,0 +1,17 @@ +# Function: SidebarSeparator() + +```ts +function SidebarSeparator(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:357](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L357) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SeparatorProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/SidebarTrigger.md b/docs/docs/api/appkit-ui/functions/SidebarTrigger.md new file mode 100644 index 0000000..593a39b --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/SidebarTrigger.md @@ -0,0 +1,17 @@ +# Function: SidebarTrigger() + +```ts +function SidebarTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:256](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L256) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ClassAttributes`\<`HTMLButtonElement`\> & `ButtonHTMLAttributes`\<`HTMLButtonElement`\> & `VariantProps`\<(`props?`) => `string`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Skeleton.md b/docs/docs/api/appkit-ui/functions/Skeleton.md new file mode 100644 index 0000000..7825077 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Skeleton.md @@ -0,0 +1,17 @@ +# Function: Skeleton() + +```ts +function Skeleton(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/skeleton.tsx:3](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/skeleton.tsx#L3) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Slider.md b/docs/docs/api/appkit-ui/functions/Slider.md new file mode 100644 index 0000000..fd1ed37 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Slider.md @@ -0,0 +1,17 @@ +# Function: Slider() + +```ts +function Slider(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/slider.tsx:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/slider.tsx#L8) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SliderProps` & `RefAttributes`\<`HTMLSpanElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Spinner.md b/docs/docs/api/appkit-ui/functions/Spinner.md new file mode 100644 index 0000000..92029fd --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Spinner.md @@ -0,0 +1,17 @@ +# Function: Spinner() + +```ts +function Spinner(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/spinner.tsx:6](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/spinner.tsx#L6) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SVGProps`\<`SVGSVGElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Switch.md b/docs/docs/api/appkit-ui/functions/Switch.md new file mode 100644 index 0000000..c3bbfae --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Switch.md @@ -0,0 +1,17 @@ +# Function: Switch() + +```ts +function Switch(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/switch.tsx:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/switch.tsx#L8) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `SwitchProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Table.md b/docs/docs/api/appkit-ui/functions/Table.md new file mode 100644 index 0000000..10de9bc --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Table.md @@ -0,0 +1,17 @@ +# Function: Table() + +```ts +function Table(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/table.tsx:5](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/table.tsx#L5) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`TableHTMLAttributes`\<`HTMLTableElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/TableBody.md b/docs/docs/api/appkit-ui/functions/TableBody.md new file mode 100644 index 0000000..850b419 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/TableBody.md @@ -0,0 +1,17 @@ +# Function: TableBody() + +```ts +function TableBody(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/table.tsx:30](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/table.tsx#L30) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLTableSectionElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/TableCaption.md b/docs/docs/api/appkit-ui/functions/TableCaption.md new file mode 100644 index 0000000..065c8b0 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/TableCaption.md @@ -0,0 +1,17 @@ +# Function: TableCaption() + +```ts +function TableCaption(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/table.tsx:92](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/table.tsx#L92) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/TableCell.md b/docs/docs/api/appkit-ui/functions/TableCell.md new file mode 100644 index 0000000..cb97e21 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/TableCell.md @@ -0,0 +1,17 @@ +# Function: TableCell() + +```ts +function TableCell(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/table.tsx:79](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/table.tsx#L79) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`TdHTMLAttributes`\<`HTMLTableDataCellElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/TableFooter.md b/docs/docs/api/appkit-ui/functions/TableFooter.md new file mode 100644 index 0000000..e9286ef --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/TableFooter.md @@ -0,0 +1,17 @@ +# Function: TableFooter() + +```ts +function TableFooter(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/table.tsx:40](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/table.tsx#L40) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLTableSectionElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/TableHead.md b/docs/docs/api/appkit-ui/functions/TableHead.md new file mode 100644 index 0000000..8158e72 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/TableHead.md @@ -0,0 +1,17 @@ +# Function: TableHead() + +```ts +function TableHead(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/table.tsx:66](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/table.tsx#L66) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`ThHTMLAttributes`\<`HTMLTableHeaderCellElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/TableHeader.md b/docs/docs/api/appkit-ui/functions/TableHeader.md new file mode 100644 index 0000000..cfb37e8 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/TableHeader.md @@ -0,0 +1,17 @@ +# Function: TableHeader() + +```ts +function TableHeader(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/table.tsx:20](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/table.tsx#L20) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLTableSectionElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/TableRow.md b/docs/docs/api/appkit-ui/functions/TableRow.md new file mode 100644 index 0000000..5bd2b86 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/TableRow.md @@ -0,0 +1,17 @@ +# Function: TableRow() + +```ts +function TableRow(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/table.tsx:53](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/table.tsx#L53) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLTableRowElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Tabs.md b/docs/docs/api/appkit-ui/functions/Tabs.md new file mode 100644 index 0000000..1678f51 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Tabs.md @@ -0,0 +1,17 @@ +# Function: Tabs() + +```ts +function Tabs(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/tabs.tsx:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tabs.tsx#L8) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `TabsProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/TabsContent.md b/docs/docs/api/appkit-ui/functions/TabsContent.md new file mode 100644 index 0000000..7aad554 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/TabsContent.md @@ -0,0 +1,17 @@ +# Function: TabsContent() + +```ts +function TabsContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/tabs.tsx:53](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tabs.tsx#L53) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `TabsContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/TabsList.md b/docs/docs/api/appkit-ui/functions/TabsList.md new file mode 100644 index 0000000..6776563 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/TabsList.md @@ -0,0 +1,17 @@ +# Function: TabsList() + +```ts +function TabsList(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/tabs.tsx:21](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tabs.tsx#L21) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `TabsListProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/TabsTrigger.md b/docs/docs/api/appkit-ui/functions/TabsTrigger.md new file mode 100644 index 0000000..bf02b00 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/TabsTrigger.md @@ -0,0 +1,17 @@ +# Function: TabsTrigger() + +```ts +function TabsTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/tabs.tsx:37](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tabs.tsx#L37) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `TabsTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Textarea.md b/docs/docs/api/appkit-ui/functions/Textarea.md new file mode 100644 index 0000000..8f367fc --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Textarea.md @@ -0,0 +1,17 @@ +# Function: Textarea() + +```ts +function Textarea(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/textarea.tsx:5](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/textarea.tsx#L5) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `DetailedHTMLProps`\<`TextareaHTMLAttributes`\<`HTMLTextAreaElement`\>\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Toaster.md b/docs/docs/api/appkit-ui/functions/Toaster.md new file mode 100644 index 0000000..2cba86c --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Toaster.md @@ -0,0 +1,17 @@ +# Function: Toaster() + +```ts +function Toaster(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sonner.tsx:12](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sonner.tsx#L12) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ToasterProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Toggle.md b/docs/docs/api/appkit-ui/functions/Toggle.md new file mode 100644 index 0000000..5f315d1 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Toggle.md @@ -0,0 +1,17 @@ +# Function: Toggle() + +```ts +function Toggle(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/toggle.tsx:29](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/toggle.tsx#L29) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ToggleProps` & `RefAttributes`\<`HTMLButtonElement`\> & `VariantProps`\<(`props?`) => `string`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ToggleGroup.md b/docs/docs/api/appkit-ui/functions/ToggleGroup.md new file mode 100644 index 0000000..7b687c0 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ToggleGroup.md @@ -0,0 +1,17 @@ +# Function: ToggleGroup() + +```ts +function ToggleGroup(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/toggle-group.tsx:18](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/toggle-group.tsx#L18) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | (ToggleGroupSingleProps \| ToggleGroupMultipleProps) & RefAttributes\ & `VariantProps`\<(`props?`) => `string`\> & `object` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/ToggleGroupItem.md b/docs/docs/api/appkit-ui/functions/ToggleGroupItem.md new file mode 100644 index 0000000..aa8709d --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/ToggleGroupItem.md @@ -0,0 +1,17 @@ +# Function: ToggleGroupItem() + +```ts +function ToggleGroupItem(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/toggle-group.tsx:49](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/toggle-group.tsx#L49) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `ToggleGroupItemProps` & `RefAttributes`\<`HTMLButtonElement`\> & `VariantProps`\<(`props?`) => `string`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/Tooltip.md b/docs/docs/api/appkit-ui/functions/Tooltip.md new file mode 100644 index 0000000..918b174 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/Tooltip.md @@ -0,0 +1,17 @@ +# Function: Tooltip() + +```ts +function Tooltip(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/tooltip.tsx:21](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tooltip.tsx#L21) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `TooltipProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/TooltipContent.md b/docs/docs/api/appkit-ui/functions/TooltipContent.md new file mode 100644 index 0000000..f6e345f --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/TooltipContent.md @@ -0,0 +1,17 @@ +# Function: TooltipContent() + +```ts +function TooltipContent(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/tooltip.tsx:37](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tooltip.tsx#L37) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `TooltipContentProps` & `RefAttributes`\<`HTMLDivElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/TooltipProvider.md b/docs/docs/api/appkit-ui/functions/TooltipProvider.md new file mode 100644 index 0000000..849f792 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/TooltipProvider.md @@ -0,0 +1,17 @@ +# Function: TooltipProvider() + +```ts +function TooltipProvider(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/tooltip.tsx:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tooltip.tsx#L8) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `TooltipProviderProps` | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/TooltipTrigger.md b/docs/docs/api/appkit-ui/functions/TooltipTrigger.md new file mode 100644 index 0000000..2db737b --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/TooltipTrigger.md @@ -0,0 +1,17 @@ +# Function: TooltipTrigger() + +```ts +function TooltipTrigger(__namedParameters): Element; +``` + +Defined in: [packages/appkit-ui/src/react/ui/tooltip.tsx:31](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/tooltip.tsx#L31) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `TooltipTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> | + +## Returns + +`Element` diff --git a/docs/docs/api/appkit-ui/functions/buildCartesianOption.md b/docs/docs/api/appkit-ui/functions/buildCartesianOption.md new file mode 100644 index 0000000..aba013b --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/buildCartesianOption.md @@ -0,0 +1,17 @@ +# Function: buildCartesianOption() + +```ts +function buildCartesianOption(ctx): Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:252](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L252) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `ctx` | [`CartesianContext`](../interfaces/CartesianContext.md) | + +## Returns + +`Record`\<`string`, `unknown`\> diff --git a/docs/docs/api/appkit-ui/functions/buildHeatmapOption.md b/docs/docs/api/appkit-ui/functions/buildHeatmapOption.md new file mode 100644 index 0000000..c6f9f27 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/buildHeatmapOption.md @@ -0,0 +1,17 @@ +# Function: buildHeatmapOption() + +```ts +function buildHeatmapOption(ctx): Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:180](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L180) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `ctx` | [`HeatmapContext`](../interfaces/HeatmapContext.md) | + +## Returns + +`Record`\<`string`, `unknown`\> diff --git a/docs/docs/api/appkit-ui/functions/buildHorizontalBarOption.md b/docs/docs/api/appkit-ui/functions/buildHorizontalBarOption.md new file mode 100644 index 0000000..2e2fe63 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/buildHorizontalBarOption.md @@ -0,0 +1,18 @@ +# Function: buildHorizontalBarOption() + +```ts +function buildHorizontalBarOption(ctx, stacked): Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:126](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L126) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `ctx` | [`OptionBuilderContext`](../interfaces/OptionBuilderContext.md) | +| `stacked` | `boolean` | + +## Returns + +`Record`\<`string`, `unknown`\> diff --git a/docs/docs/api/appkit-ui/functions/buildPieOption.md b/docs/docs/api/appkit-ui/functions/buildPieOption.md new file mode 100644 index 0000000..0b07674 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/buildPieOption.md @@ -0,0 +1,26 @@ +# Function: buildPieOption() + +```ts +function buildPieOption( + ctx, + chartType, + innerRadius, + showLabels, +labelPosition): Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:79](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L79) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `ctx` | [`OptionBuilderContext`](../interfaces/OptionBuilderContext.md) | +| `chartType` | `"pie"` \| `"donut"` | +| `innerRadius` | `number` | +| `showLabels` | `boolean` | +| `labelPosition` | `string` | + +## Returns + +`Record`\<`string`, `unknown`\> diff --git a/docs/docs/api/appkit-ui/functions/buildRadarOption.md b/docs/docs/api/appkit-ui/functions/buildRadarOption.md new file mode 100644 index 0000000..a4b4ac3 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/buildRadarOption.md @@ -0,0 +1,18 @@ +# Function: buildRadarOption() + +```ts +function buildRadarOption(ctx, showArea): Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:41](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L41) + +## Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `ctx` | [`OptionBuilderContext`](../interfaces/OptionBuilderContext.md) | `undefined` | +| `showArea` | `boolean` | `true` | + +## Returns + +`Record`\<`string`, `unknown`\> diff --git a/docs/docs/api/appkit-ui/functions/createChart.md b/docs/docs/api/appkit-ui/functions/createChart.md new file mode 100644 index 0000000..a84c59d --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/createChart.md @@ -0,0 +1,57 @@ +# Function: createChart() + +```ts +function createChart(chartType, displayName): { +(props): Element; + displayName: string; +}; +``` + +Defined in: [packages/appkit-ui/src/react/charts/create-chart.tsx:19](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/create-chart.tsx#L19) + +Factory function to create chart components. +Eliminates boilerplate by generating components with the same pattern. + +## Type Parameters + +| Type Parameter | +| ------ | +| `TProps` *extends* [`UnifiedChartProps`](../type-aliases/UnifiedChartProps.md) | + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `chartType` | [`ChartType`](../type-aliases/ChartType.md) | The ECharts chart type | +| `displayName` | `string` | Component display name for React DevTools | + +## Returns + +A typed chart component + +```ts +(props): Element; +``` + +### Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | `TProps` | + +### Returns + +`Element` + +### displayName + +```ts +displayName: string; +``` + +## Example + +```tsx +export const BarChart = createChart("bar", "BarChart"); +export const LineChart = createChart("line", "LineChart"); +``` diff --git a/docs/docs/api/appkit-ui/functions/createTimeSeriesData.md b/docs/docs/api/appkit-ui/functions/createTimeSeriesData.md new file mode 100644 index 0000000..e986e79 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/createTimeSeriesData.md @@ -0,0 +1,20 @@ +# Function: createTimeSeriesData() + +```ts +function createTimeSeriesData(xData, yData): [string | number, string | number][]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/utils.ts:68](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/utils.ts#L68) + +Creates time-series data pairs for ECharts. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `xData` | (`string` \| `number`)[] | +| `yData` | (`string` \| `number`)[] | + +## Returns + +\[`string` \| `number`, `string` \| `number`\][] diff --git a/docs/docs/api/appkit-ui/functions/formatLabel.md b/docs/docs/api/appkit-ui/functions/formatLabel.md new file mode 100644 index 0000000..dd03cc2 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/formatLabel.md @@ -0,0 +1,22 @@ +# Function: formatLabel() + +```ts +function formatLabel(field): string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/utils.ts:40](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/utils.ts#L40) + +Formats a field name into a human-readable label. +Handles camelCase, snake_case, acronyms, and ALL_CAPS. +E.g., "totalSpend" -> "Total Spend", "user_name" -> "User Name", + "userID" -> "User Id", "TOTAL_SPEND" -> "Total Spend" + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `field` | `string` | + +## Returns + +`string` diff --git a/docs/docs/api/appkit-ui/functions/isArrowTable.md b/docs/docs/api/appkit-ui/functions/isArrowTable.md new file mode 100644 index 0000000..008cb20 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/isArrowTable.md @@ -0,0 +1,19 @@ +# Function: isArrowTable() + +```ts +function isArrowTable(data): data is Table; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:221](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L221) + +Type guard to check if data is an Arrow Table + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | [`ChartData`](../type-aliases/ChartData.md) | + +## Returns + +`data is Table` diff --git a/docs/docs/api/appkit-ui/functions/isDataProps.md b/docs/docs/api/appkit-ui/functions/isDataProps.md new file mode 100644 index 0000000..7265941 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/isDataProps.md @@ -0,0 +1,19 @@ +# Function: isDataProps() + +```ts +function isDataProps(props): props is DataProps; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:241](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L241) + +Type guard to check if props are data-based + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`UnifiedChartProps`](../type-aliases/UnifiedChartProps.md) | + +## Returns + +`props is DataProps` diff --git a/docs/docs/api/appkit-ui/functions/isQueryProps.md b/docs/docs/api/appkit-ui/functions/isQueryProps.md new file mode 100644 index 0000000..de8dca1 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/isQueryProps.md @@ -0,0 +1,19 @@ +# Function: isQueryProps() + +```ts +function isQueryProps(props): props is QueryProps; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:232](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L232) + +Type guard to check if props are query-based + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`UnifiedChartProps`](../type-aliases/UnifiedChartProps.md) | + +## Returns + +`props is QueryProps` diff --git a/docs/docs/api/appkit-ui/functions/normalizeChartData.md b/docs/docs/api/appkit-ui/functions/normalizeChartData.md new file mode 100644 index 0000000..7fdd52b --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/normalizeChartData.md @@ -0,0 +1,27 @@ +# Function: normalizeChartData() + +```ts +function normalizeChartData( + data, + xKey?, + yKey?, + orientation?): NormalizedChartData; +``` + +Defined in: [packages/appkit-ui/src/react/charts/normalize.ts:216](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/normalize.ts#L216) + +Normalizes chart data from either Arrow or JSON format. +Converts BigInt and Date values to chart-compatible types. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | [`ChartData`](../type-aliases/ChartData.md) | +| `xKey?` | `string` | +| `yKey?` | `string` \| `string`[] | +| `orientation?` | [`Orientation`](../type-aliases/Orientation.md) | + +## Returns + +[`NormalizedChartData`](../interfaces/NormalizedChartData.md) diff --git a/docs/docs/api/appkit-ui/functions/normalizeHeatmapData.md b/docs/docs/api/appkit-ui/functions/normalizeHeatmapData.md new file mode 100644 index 0000000..54564b1 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/normalizeHeatmapData.md @@ -0,0 +1,27 @@ +# Function: normalizeHeatmapData() + +```ts +function normalizeHeatmapData( + data, + xKey?, + yAxisKey?, + valueKey?): NormalizedHeatmapData; +``` + +Defined in: [packages/appkit-ui/src/react/charts/normalize.ts:326](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/normalize.ts#L326) + +Normalizes data specifically for heatmap charts. +Expects data in format: `{ xKey: string, yAxisKey: string, valueKey: number }` + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `data` | [`ChartData`](../type-aliases/ChartData.md) | Raw data (Arrow Table or JSON array) | +| `xKey?` | `string` | Field key for X-axis (columns) | +| `yAxisKey?` | `string` | Field key for Y-axis (rows) | +| `valueKey?` | `string` \| `string`[] | Field key for the cell values | + +## Returns + +[`NormalizedHeatmapData`](../interfaces/NormalizedHeatmapData.md) diff --git a/docs/docs/api/appkit-ui/functions/sortTimeSeriesAscending.md b/docs/docs/api/appkit-ui/functions/sortTimeSeriesAscending.md new file mode 100644 index 0000000..f755986 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/sortTimeSeriesAscending.md @@ -0,0 +1,36 @@ +# Function: sortTimeSeriesAscending() + +```ts +function sortTimeSeriesAscending( + xData, + yDataMap, + yFields): object; +``` + +Defined in: [packages/appkit-ui/src/react/charts/utils.ts:83](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/utils.ts#L83) + +Sorts time-series data in ascending chronological order. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `xData` | (`string` \| `number`)[] | +| `yDataMap` | `Record`\<`string`, (`string` \| `number`)[]\> | +| `yFields` | `string`[] | + +## Returns + +`object` + +### xData + +```ts +xData: (string | number)[]; +``` + +### yDataMap + +```ts +yDataMap: Record; +``` diff --git a/docs/docs/api/appkit-ui/functions/toChartArray.md b/docs/docs/api/appkit-ui/functions/toChartArray.md new file mode 100644 index 0000000..f6c26e5 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/toChartArray.md @@ -0,0 +1,19 @@ +# Function: toChartArray() + +```ts +function toChartArray(data): (string | number)[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/utils.ts:29](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/utils.ts#L29) + +Converts an array of values to chart-compatible types. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `unknown`[] | + +## Returns + +(`string` \| `number`)[] diff --git a/docs/docs/api/appkit-ui/functions/toChartValue.md b/docs/docs/api/appkit-ui/functions/toChartValue.md new file mode 100644 index 0000000..ac1a953 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/toChartValue.md @@ -0,0 +1,21 @@ +# Function: toChartValue() + +```ts +function toChartValue(value): string | number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/utils.ts:10](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/utils.ts#L10) + +Converts a value to a chart-compatible type. +Handles BigInt conversion (Arrow can return BigInt64Array values). +Handles Date objects by converting to timestamps. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `value` | `unknown` | + +## Returns + +`string` \| `number` diff --git a/docs/docs/api/appkit-ui/functions/truncateLabel.md b/docs/docs/api/appkit-ui/functions/truncateLabel.md new file mode 100644 index 0000000..2b0a1ef --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/truncateLabel.md @@ -0,0 +1,20 @@ +# Function: truncateLabel() + +```ts +function truncateLabel(value, maxLength): string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/utils.ts:61](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/utils.ts#L61) + +Truncates a label to a maximum length with ellipsis. + +## Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `value` | `string` | `undefined` | +| `maxLength` | `number` | `15` | + +## Returns + +`string` diff --git a/docs/docs/api/appkit-ui/functions/useAllThemeColors.md b/docs/docs/api/appkit-ui/functions/useAllThemeColors.md new file mode 100644 index 0000000..2ace5ea --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/useAllThemeColors.md @@ -0,0 +1,32 @@ +# Function: useAllThemeColors() + +```ts +function useAllThemeColors(): object; +``` + +Defined in: [packages/appkit-ui/src/react/charts/theme.ts:131](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/theme.ts#L131) + +Hook to get all three color palettes at once. +Useful when a component needs access to multiple palette types. + +## Returns + +`object` + +### categorical + +```ts +categorical: string[]; +``` + +### diverging + +```ts +diverging: string[]; +``` + +### sequential + +```ts +sequential: string[]; +``` diff --git a/docs/docs/api/appkit-ui/functions/useAnalyticsQuery.md b/docs/docs/api/appkit-ui/functions/useAnalyticsQuery.md new file mode 100644 index 0000000..72a8a7e --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/useAnalyticsQuery.md @@ -0,0 +1,51 @@ +# Function: useAnalyticsQuery() + +```ts +function useAnalyticsQuery( + queryKey, + parameters?, +options?): UseAnalyticsQueryResult>; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/use-analytics-query.ts:50](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/use-analytics-query.ts#L50) + +Subscribe to an analytics query over SSE and returns its latest result. +Integration hook between client and analytics plugin. + +The return type is automatically inferred based on the format: +- `format: "JSON"` (default): Returns typed array from QueryRegistry +- `format: "ARROW"`: Returns TypedArrowTable with row type preserved + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `T` | `unknown` | +| `K` *extends* `string` | `string` | +| `F` *extends* [`AnalyticsFormat`](../type-aliases/AnalyticsFormat.md) | `"JSON"` | + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `queryKey` | `K` | Analytics query identifier | +| `parameters?` | `InferParams`\<`K`\> \| `null` | Query parameters (type-safe based on QueryRegistry) | +| `options?` | [`UseAnalyticsQueryOptions`](../interfaces/UseAnalyticsQueryOptions.md)\<`F`\> | Analytics query settings including format | + +## Returns + +[`UseAnalyticsQueryResult`](../interfaces/UseAnalyticsQueryResult.md)\<[`InferResultByFormat`](../type-aliases/InferResultByFormat.md)\<`T`, `K`, `F`\>\> + +Query result state with format-appropriate data type + +## Examples + +```typescript +const { data } = useAnalyticsQuery("spend_data", params); +// data: Array<{ group_key: string; cost_usd: number; ... }> | null +``` + +```typescript +const { data } = useAnalyticsQuery("spend_data", params, { format: "ARROW" }); +// data: TypedArrowTable<{ group_key: string; cost_usd: number; ... }> | null +``` diff --git a/docs/docs/api/appkit-ui/functions/useChartData.md b/docs/docs/api/appkit-ui/functions/useChartData.md new file mode 100644 index 0000000..8c35348 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/useChartData.md @@ -0,0 +1,36 @@ +# Function: useChartData() + +```ts +function useChartData(options): UseChartDataResult; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/use-chart-data.ts:104](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/use-chart-data.ts#L104) + +Hook for fetching chart data in either JSON or Arrow format. +Automatically selects the best format based on query hints. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `options` | [`UseChartDataOptions`](../interfaces/UseChartDataOptions.md) | + +## Returns + +[`UseChartDataResult`](../interfaces/UseChartDataResult.md) + +## Example + +```tsx +// Auto-select format +const { data, isArrow, loading } = useChartData({ + queryKey: "spend_data", + parameters: { limit: 1000 } +}); + +// Force Arrow format +const { data } = useChartData({ + queryKey: "big_query", + format: "arrow" +}); +``` diff --git a/docs/docs/api/appkit-ui/functions/useFormField.md b/docs/docs/api/appkit-ui/functions/useFormField.md new file mode 100644 index 0000000..326178c --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/useFormField.md @@ -0,0 +1,41 @@ +# Function: useFormField() + +```ts +function useFormField(): object; +``` + +Defined in: [packages/appkit-ui/src/react/ui/form.tsx:45](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx#L45) + +## Returns + +`object` + +### formDescriptionId + +```ts +formDescriptionId: string; +``` + +### formItemId + +```ts +formItemId: string; +``` + +### formMessageId + +```ts +formMessageId: string; +``` + +### id + +```ts +id: string; +``` + +### name + +```ts +name: string = fieldContext.name; +``` diff --git a/docs/docs/api/appkit-ui/functions/useSidebar.md b/docs/docs/api/appkit-ui/functions/useSidebar.md new file mode 100644 index 0000000..4cfd0f2 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/useSidebar.md @@ -0,0 +1,11 @@ +# Function: useSidebar() + +```ts +function useSidebar(): SidebarContextProps; +``` + +Defined in: [packages/appkit-ui/src/react/ui/sidebar.tsx:47](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/sidebar.tsx#L47) + +## Returns + +`SidebarContextProps` diff --git a/docs/docs/api/appkit-ui/functions/useThemeColors.md b/docs/docs/api/appkit-ui/functions/useThemeColors.md new file mode 100644 index 0000000..1083b30 --- /dev/null +++ b/docs/docs/api/appkit-ui/functions/useThemeColors.md @@ -0,0 +1,20 @@ +# Function: useThemeColors() + +```ts +function useThemeColors(palette): string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/theme.ts:91](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/theme.ts#L91) + +Hook to get theme colors with automatic updates on theme change. +Re-resolves CSS variables when color scheme or theme attributes change. + +## Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `palette` | [`ChartColorPalette`](../type-aliases/ChartColorPalette.md) | `"categorical"` | Color palette type: "categorical" (default), "sequential", or "diverging" | + +## Returns + +`string`[] diff --git a/docs/docs/api/appkit-ui/index.md b/docs/docs/api/appkit-ui/index.md new file mode 100644 index 0000000..b64df9e --- /dev/null +++ b/docs/docs/api/appkit-ui/index.md @@ -0,0 +1,392 @@ +# @databricks/appkit-ui + +## Interfaces + +| Interface | Description | +| ------ | ------ | +| [AreaChartSpecificProps](interfaces/AreaChartSpecificProps.md) | Props specific to area charts | +| [BarChartSpecificProps](interfaces/BarChartSpecificProps.md) | Props specific to bar charts | +| [BaseChartProps](interfaces/BaseChartProps.md) | - | +| [CartesianContext](interfaces/CartesianContext.md) | - | +| [ChartBaseProps](interfaces/ChartBaseProps.md) | Common visual and behavior props for all charts | +| [DataProps](interfaces/DataProps.md) | Props for direct data injection | +| [HeatmapChartSpecificProps](interfaces/HeatmapChartSpecificProps.md) | Props specific to heatmap charts | +| [HeatmapContext](interfaces/HeatmapContext.md) | - | +| [LineChartSpecificProps](interfaces/LineChartSpecificProps.md) | Props specific to line charts | +| [NormalizedChartData](interfaces/NormalizedChartData.md) | Normalized chart data for rendering (standard charts) | +| [NormalizedChartDataBase](interfaces/NormalizedChartDataBase.md) | Base normalized data shared by all chart types | +| [NormalizedHeatmapData](interfaces/NormalizedHeatmapData.md) | Normalized data for heatmap charts. Extends base (not NormalizedChartData) because heatmaps don't use yDataMap. Instead, they use heatmapData which contains [xIndex, yIndex, value] tuples. | +| [OptionBuilderContext](interfaces/OptionBuilderContext.md) | - | +| [PieChartSpecificProps](interfaces/PieChartSpecificProps.md) | Props specific to pie/donut charts | +| [PluginRegistry](interfaces/PluginRegistry.md) | - | +| [QueryProps](interfaces/QueryProps.md) | Props for query-based data fetching | +| [QueryRegistry](interfaces/QueryRegistry.md) | Query Registry for type-safe analytics queries. Extend this interface via module augmentation to get full type inference: | +| [RadarChartSpecificProps](interfaces/RadarChartSpecificProps.md) | Props specific to radar charts | +| [ScatterChartSpecificProps](interfaces/ScatterChartSpecificProps.md) | Props specific to scatter charts | +| [TypedArrowTable](interfaces/TypedArrowTable.md) | Typed Arrow Table - preserves row type information for type inference. At runtime this is just a regular Arrow Table, but TypeScript knows the row schema. | +| [UseAnalyticsQueryOptions](interfaces/UseAnalyticsQueryOptions.md) | Options for configuring an analytics SSE query | +| [UseAnalyticsQueryResult](interfaces/UseAnalyticsQueryResult.md) | Result state returned by useAnalyticsQuery | +| [UseChartDataOptions](interfaces/UseChartDataOptions.md) | - | +| [UseChartDataResult](interfaces/UseChartDataResult.md) | - | + +## Type Aliases + +| Type Alias | Description | +| ------ | ------ | +| [AnalyticsFormat](type-aliases/AnalyticsFormat.md) | Supported response formats for analytics queries | +| [AreaChartProps](type-aliases/AreaChartProps.md) | - | +| [BarChartProps](type-aliases/BarChartProps.md) | - | +| [CarouselApi](type-aliases/CarouselApi.md) | - | +| [ChartColorPalette](type-aliases/ChartColorPalette.md) | Color palette types for different visualization needs | +| [ChartConfig](type-aliases/ChartConfig.md) | - | +| [ChartData](type-aliases/ChartData.md) | Data that can be passed to unified charts | +| [ChartType](type-aliases/ChartType.md) | Supported chart types | +| [ChartWrapperProps](type-aliases/ChartWrapperProps.md) | - | +| [DataFormat](type-aliases/DataFormat.md) | Supported data formats for analytics queries | +| [DonutChartProps](type-aliases/DonutChartProps.md) | - | +| [HeatmapChartProps](type-aliases/HeatmapChartProps.md) | - | +| [InferResultByFormat](type-aliases/InferResultByFormat.md) | Conditionally infers result type based on format. - JSON format: Returns the typed array from QueryRegistry - ARROW format: Returns TypedArrowTable with row type preserved | +| [InferRowType](type-aliases/InferRowType.md) | Infers the row type from a query result array. Used for TypedArrowTable row typing. | +| [LineChartProps](type-aliases/LineChartProps.md) | - | +| [Orientation](type-aliases/Orientation.md) | Chart orientation | +| [PieChartProps](type-aliases/PieChartProps.md) | - | +| [RadarChartProps](type-aliases/RadarChartProps.md) | - | +| [ScatterChartProps](type-aliases/ScatterChartProps.md) | - | +| [UnifiedChartProps](type-aliases/UnifiedChartProps.md) | Base union type - either query-based or data-based | + +## Variables + +| Variable | Description | +| ------ | ------ | +| [AreaChart](variables/AreaChart.md) | Area Chart component. Supports both JSON and Arrow data formats with automatic format selection. | +| [badgeVariants](variables/badgeVariants.md) | - | +| [BarChart](variables/BarChart.md) | Bar Chart component. Supports both JSON and Arrow data formats with automatic format selection. | +| [buttonGroupVariants](variables/buttonGroupVariants.md) | - | +| [buttonVariants](variables/buttonVariants.md) | - | +| [CHART\_COLOR\_VARS](variables/CHART_COLOR_VARS.md) | Legacy: CSS variable names for chart colors (aliases to categorical) | +| [CHART\_COLOR\_VARS\_CATEGORICAL](variables/CHART_COLOR_VARS_CATEGORICAL.md) | CSS variable names for categorical chart colors (distinct categories) | +| [CHART\_COLOR\_VARS\_DIVERGING](variables/CHART_COLOR_VARS_DIVERGING.md) | CSS variable names for diverging chart colors (negative ↔ positive) | +| [CHART\_COLOR\_VARS\_SEQUENTIAL](variables/CHART_COLOR_VARS_SEQUENTIAL.md) | CSS variable names for sequential chart colors (low → high) | +| [ChartLegend](variables/ChartLegend.md) | - | +| [ChartTooltip](variables/ChartTooltip.md) | - | +| [DATE\_FIELD\_PATTERNS](variables/DATE_FIELD_PATTERNS.md) | Field patterns to detect date/time fields by name | +| [DonutChart](variables/DonutChart.md) | Donut Chart component (Pie chart with inner radius). Supports both JSON and Arrow data formats with automatic format selection. | +| [FALLBACK\_COLORS](variables/FALLBACK_COLORS.md) | Legacy: Fallback colors (aliases to categorical) | +| [FALLBACK\_COLORS\_CATEGORICAL](variables/FALLBACK_COLORS_CATEGORICAL.md) | Fallback categorical colors | +| [FALLBACK\_COLORS\_DIVERGING](variables/FALLBACK_COLORS_DIVERGING.md) | Fallback diverging colors (blue → red) | +| [FALLBACK\_COLORS\_SEQUENTIAL](variables/FALLBACK_COLORS_SEQUENTIAL.md) | Fallback sequential colors (light → dark blue) | +| [Form](variables/Form.md) | - | +| [HeatmapChart](variables/HeatmapChart.md) | Heatmap Chart component. Supports both JSON and Arrow data formats with automatic format selection. | +| [LineChart](variables/LineChart.md) | Line Chart component. Supports both JSON and Arrow data formats with automatic format selection. | +| [METADATA\_DATE\_PATTERNS](variables/METADATA_DATE_PATTERNS.md) | Patterns that indicate a date field is metadata, not for charting | +| [NAME\_FIELD\_PATTERNS](variables/NAME_FIELD_PATTERNS.md) | Field patterns to detect name/category fields by name | +| [navigationMenuTriggerStyle](variables/navigationMenuTriggerStyle.md) | - | +| [PieChart](variables/PieChart.md) | Pie Chart component. Supports both JSON and Arrow data formats with automatic format selection. | +| [RadarChart](variables/RadarChart.md) | Radar Chart component. Supports both JSON and Arrow data formats with automatic format selection. | +| [ScatterChart](variables/ScatterChart.md) | Scatter Chart component. Supports both JSON and Arrow data formats with automatic format selection. | +| [toggleVariants](variables/toggleVariants.md) | - | + +## Functions + +| Function | Description | +| ------ | ------ | +| [Accordion](functions/Accordion.md) | - | +| [AccordionContent](functions/AccordionContent.md) | - | +| [AccordionItem](functions/AccordionItem.md) | - | +| [AccordionTrigger](functions/AccordionTrigger.md) | - | +| [Alert](functions/Alert.md) | - | +| [AlertDescription](functions/AlertDescription.md) | - | +| [AlertDialog](functions/AlertDialog.md) | - | +| [AlertDialogAction](functions/AlertDialogAction.md) | - | +| [AlertDialogCancel](functions/AlertDialogCancel.md) | - | +| [AlertDialogContent](functions/AlertDialogContent.md) | - | +| [AlertDialogDescription](functions/AlertDialogDescription.md) | - | +| [AlertDialogFooter](functions/AlertDialogFooter.md) | - | +| [AlertDialogHeader](functions/AlertDialogHeader.md) | - | +| [AlertDialogOverlay](functions/AlertDialogOverlay.md) | - | +| [AlertDialogPortal](functions/AlertDialogPortal.md) | - | +| [AlertDialogTitle](functions/AlertDialogTitle.md) | - | +| [AlertDialogTrigger](functions/AlertDialogTrigger.md) | - | +| [AlertTitle](functions/AlertTitle.md) | - | +| [AspectRatio](functions/AspectRatio.md) | - | +| [Avatar](functions/Avatar.md) | - | +| [AvatarFallback](functions/AvatarFallback.md) | - | +| [AvatarImage](functions/AvatarImage.md) | - | +| [Badge](functions/Badge.md) | - | +| [BaseChart](functions/BaseChart.md) | Base chart component that handles both Arrow and JSON data. Renders using ECharts for consistent output across both formats. | +| [Breadcrumb](functions/Breadcrumb.md) | - | +| [BreadcrumbEllipsis](functions/BreadcrumbEllipsis.md) | - | +| [BreadcrumbItem](functions/BreadcrumbItem.md) | - | +| [BreadcrumbLink](functions/BreadcrumbLink.md) | - | +| [BreadcrumbList](functions/BreadcrumbList.md) | - | +| [BreadcrumbPage](functions/BreadcrumbPage.md) | - | +| [BreadcrumbSeparator](functions/BreadcrumbSeparator.md) | - | +| [buildCartesianOption](functions/buildCartesianOption.md) | - | +| [buildHeatmapOption](functions/buildHeatmapOption.md) | - | +| [buildHorizontalBarOption](functions/buildHorizontalBarOption.md) | - | +| [buildPieOption](functions/buildPieOption.md) | - | +| [buildRadarOption](functions/buildRadarOption.md) | - | +| [Button](functions/Button.md) | - | +| [ButtonGroup](functions/ButtonGroup.md) | - | +| [ButtonGroupSeparator](functions/ButtonGroupSeparator.md) | - | +| [ButtonGroupText](functions/ButtonGroupText.md) | - | +| [Calendar](functions/Calendar.md) | - | +| [CalendarDayButton](functions/CalendarDayButton.md) | - | +| [Card](functions/Card.md) | - | +| [CardAction](functions/CardAction.md) | - | +| [CardContent](functions/CardContent.md) | - | +| [CardDescription](functions/CardDescription.md) | - | +| [CardFooter](functions/CardFooter.md) | - | +| [CardHeader](functions/CardHeader.md) | - | +| [CardTitle](functions/CardTitle.md) | - | +| [Carousel](functions/Carousel.md) | - | +| [CarouselContent](functions/CarouselContent.md) | - | +| [CarouselItem](functions/CarouselItem.md) | - | +| [CarouselNext](functions/CarouselNext.md) | - | +| [CarouselPrevious](functions/CarouselPrevious.md) | - | +| [ChartContainer](functions/ChartContainer.md) | - | +| [ChartLegendContent](functions/ChartLegendContent.md) | - | +| [ChartStyle](functions/ChartStyle.md) | - | +| [ChartTooltipContent](functions/ChartTooltipContent.md) | - | +| [ChartWrapper](functions/ChartWrapper.md) | Wrapper component for charts. Handles data fetching (query mode) or direct data injection (data mode). | +| [Checkbox](functions/Checkbox.md) | - | +| [Collapsible](functions/Collapsible.md) | - | +| [CollapsibleContent](functions/CollapsibleContent.md) | - | +| [CollapsibleTrigger](functions/CollapsibleTrigger.md) | - | +| [Command](functions/Command.md) | - | +| [CommandDialog](functions/CommandDialog.md) | - | +| [CommandEmpty](functions/CommandEmpty.md) | - | +| [CommandGroup](functions/CommandGroup.md) | - | +| [CommandInput](functions/CommandInput.md) | - | +| [CommandItem](functions/CommandItem.md) | - | +| [CommandList](functions/CommandList.md) | - | +| [CommandSeparator](functions/CommandSeparator.md) | - | +| [CommandShortcut](functions/CommandShortcut.md) | - | +| [ContextMenu](functions/ContextMenu.md) | - | +| [ContextMenuCheckboxItem](functions/ContextMenuCheckboxItem.md) | - | +| [ContextMenuContent](functions/ContextMenuContent.md) | - | +| [ContextMenuGroup](functions/ContextMenuGroup.md) | - | +| [ContextMenuItem](functions/ContextMenuItem.md) | - | +| [ContextMenuLabel](functions/ContextMenuLabel.md) | - | +| [ContextMenuPortal](functions/ContextMenuPortal.md) | - | +| [ContextMenuRadioGroup](functions/ContextMenuRadioGroup.md) | - | +| [ContextMenuRadioItem](functions/ContextMenuRadioItem.md) | - | +| [ContextMenuSeparator](functions/ContextMenuSeparator.md) | - | +| [ContextMenuShortcut](functions/ContextMenuShortcut.md) | - | +| [ContextMenuSub](functions/ContextMenuSub.md) | - | +| [ContextMenuSubContent](functions/ContextMenuSubContent.md) | - | +| [ContextMenuSubTrigger](functions/ContextMenuSubTrigger.md) | - | +| [ContextMenuTrigger](functions/ContextMenuTrigger.md) | - | +| [createChart](functions/createChart.md) | Factory function to create chart components. Eliminates boilerplate by generating components with the same pattern. | +| [createTimeSeriesData](functions/createTimeSeriesData.md) | Creates time-series data pairs for ECharts. | +| [DataTable](functions/DataTable.md) | Production-ready data table with automatic data fetching and state management Features: - Automatic column generation from data structure - Integrated with useAnalyticsQuery for data fetching - Built-in loading, error, and empty states - Dynamic filtering, sorting and pagination - Column visibility controls - Responsive design | +| [Dialog](functions/Dialog.md) | - | +| [DialogClose](functions/DialogClose.md) | - | +| [DialogContent](functions/DialogContent.md) | - | +| [DialogDescription](functions/DialogDescription.md) | - | +| [DialogFooter](functions/DialogFooter.md) | - | +| [DialogHeader](functions/DialogHeader.md) | - | +| [DialogOverlay](functions/DialogOverlay.md) | - | +| [DialogPortal](functions/DialogPortal.md) | - | +| [DialogTitle](functions/DialogTitle.md) | - | +| [DialogTrigger](functions/DialogTrigger.md) | - | +| [Drawer](functions/Drawer.md) | - | +| [DrawerClose](functions/DrawerClose.md) | - | +| [DrawerContent](functions/DrawerContent.md) | - | +| [DrawerDescription](functions/DrawerDescription.md) | - | +| [DrawerFooter](functions/DrawerFooter.md) | - | +| [DrawerHeader](functions/DrawerHeader.md) | - | +| [DrawerOverlay](functions/DrawerOverlay.md) | - | +| [DrawerPortal](functions/DrawerPortal.md) | - | +| [DrawerTitle](functions/DrawerTitle.md) | - | +| [DrawerTrigger](functions/DrawerTrigger.md) | - | +| [DropdownMenu](functions/DropdownMenu.md) | - | +| [DropdownMenuCheckboxItem](functions/DropdownMenuCheckboxItem.md) | - | +| [DropdownMenuContent](functions/DropdownMenuContent.md) | - | +| [DropdownMenuGroup](functions/DropdownMenuGroup.md) | - | +| [DropdownMenuItem](functions/DropdownMenuItem.md) | - | +| [DropdownMenuLabel](functions/DropdownMenuLabel.md) | - | +| [DropdownMenuPortal](functions/DropdownMenuPortal.md) | - | +| [DropdownMenuRadioGroup](functions/DropdownMenuRadioGroup.md) | - | +| [DropdownMenuRadioItem](functions/DropdownMenuRadioItem.md) | - | +| [DropdownMenuSeparator](functions/DropdownMenuSeparator.md) | - | +| [DropdownMenuShortcut](functions/DropdownMenuShortcut.md) | - | +| [DropdownMenuSub](functions/DropdownMenuSub.md) | - | +| [DropdownMenuSubContent](functions/DropdownMenuSubContent.md) | - | +| [DropdownMenuSubTrigger](functions/DropdownMenuSubTrigger.md) | - | +| [DropdownMenuTrigger](functions/DropdownMenuTrigger.md) | - | +| [Empty](functions/Empty.md) | - | +| [EmptyContent](functions/EmptyContent.md) | - | +| [EmptyDescription](functions/EmptyDescription.md) | - | +| [EmptyHeader](functions/EmptyHeader.md) | - | +| [EmptyMedia](functions/EmptyMedia.md) | - | +| [EmptyTitle](functions/EmptyTitle.md) | - | +| [Field](functions/Field.md) | - | +| [FieldContent](functions/FieldContent.md) | - | +| [FieldDescription](functions/FieldDescription.md) | - | +| [FieldError](functions/FieldError.md) | - | +| [FieldGroup](functions/FieldGroup.md) | - | +| [FieldLabel](functions/FieldLabel.md) | - | +| [FieldLegend](functions/FieldLegend.md) | - | +| [FieldSeparator](functions/FieldSeparator.md) | - | +| [FieldSet](functions/FieldSet.md) | - | +| [FieldTitle](functions/FieldTitle.md) | - | +| [formatLabel](functions/formatLabel.md) | Formats a field name into a human-readable label. Handles camelCase, snake_case, acronyms, and ALL_CAPS. E.g., "totalSpend" -> "Total Spend", "user_name" -> "User Name", "userID" -> "User Id", "TOTAL_SPEND" -> "Total Spend" | +| [FormControl](functions/FormControl.md) | - | +| [FormDescription](functions/FormDescription.md) | - | +| [FormField](functions/FormField.md) | - | +| [FormItem](functions/FormItem.md) | - | +| [FormLabel](functions/FormLabel.md) | - | +| [FormMessage](functions/FormMessage.md) | - | +| [HoverCard](functions/HoverCard.md) | - | +| [HoverCardContent](functions/HoverCardContent.md) | - | +| [HoverCardTrigger](functions/HoverCardTrigger.md) | - | +| [Input](functions/Input.md) | - | +| [InputGroup](functions/InputGroup.md) | - | +| [InputGroupAddon](functions/InputGroupAddon.md) | - | +| [InputGroupButton](functions/InputGroupButton.md) | - | +| [InputGroupInput](functions/InputGroupInput.md) | - | +| [InputGroupText](functions/InputGroupText.md) | - | +| [InputGroupTextarea](functions/InputGroupTextarea.md) | - | +| [InputOTP](functions/InputOTP.md) | - | +| [InputOTPGroup](functions/InputOTPGroup.md) | - | +| [InputOTPSeparator](functions/InputOTPSeparator.md) | - | +| [InputOTPSlot](functions/InputOTPSlot.md) | - | +| [isArrowTable](functions/isArrowTable.md) | Type guard to check if data is an Arrow Table | +| [isDataProps](functions/isDataProps.md) | Type guard to check if props are data-based | +| [isQueryProps](functions/isQueryProps.md) | Type guard to check if props are query-based | +| [Item](functions/Item.md) | - | +| [ItemActions](functions/ItemActions.md) | - | +| [ItemContent](functions/ItemContent.md) | - | +| [ItemDescription](functions/ItemDescription.md) | - | +| [ItemFooter](functions/ItemFooter.md) | - | +| [ItemGroup](functions/ItemGroup.md) | - | +| [ItemHeader](functions/ItemHeader.md) | - | +| [ItemMedia](functions/ItemMedia.md) | - | +| [ItemSeparator](functions/ItemSeparator.md) | - | +| [ItemTitle](functions/ItemTitle.md) | - | +| [Kbd](functions/Kbd.md) | - | +| [KbdGroup](functions/KbdGroup.md) | - | +| [Label](functions/Label.md) | - | +| [Menubar](functions/Menubar.md) | - | +| [MenubarCheckboxItem](functions/MenubarCheckboxItem.md) | - | +| [MenubarContent](functions/MenubarContent.md) | - | +| [MenubarGroup](functions/MenubarGroup.md) | - | +| [MenubarItem](functions/MenubarItem.md) | - | +| [MenubarLabel](functions/MenubarLabel.md) | - | +| [MenubarMenu](functions/MenubarMenu.md) | - | +| [MenubarPortal](functions/MenubarPortal.md) | - | +| [MenubarRadioGroup](functions/MenubarRadioGroup.md) | - | +| [MenubarRadioItem](functions/MenubarRadioItem.md) | - | +| [MenubarSeparator](functions/MenubarSeparator.md) | - | +| [MenubarShortcut](functions/MenubarShortcut.md) | - | +| [MenubarSub](functions/MenubarSub.md) | - | +| [MenubarSubContent](functions/MenubarSubContent.md) | - | +| [MenubarSubTrigger](functions/MenubarSubTrigger.md) | - | +| [MenubarTrigger](functions/MenubarTrigger.md) | - | +| [NavigationMenu](functions/NavigationMenu.md) | - | +| [NavigationMenuContent](functions/NavigationMenuContent.md) | - | +| [NavigationMenuIndicator](functions/NavigationMenuIndicator.md) | - | +| [NavigationMenuItem](functions/NavigationMenuItem.md) | - | +| [NavigationMenuLink](functions/NavigationMenuLink.md) | - | +| [NavigationMenuList](functions/NavigationMenuList.md) | - | +| [NavigationMenuTrigger](functions/NavigationMenuTrigger.md) | - | +| [NavigationMenuViewport](functions/NavigationMenuViewport.md) | - | +| [normalizeChartData](functions/normalizeChartData.md) | Normalizes chart data from either Arrow or JSON format. Converts BigInt and Date values to chart-compatible types. | +| [normalizeHeatmapData](functions/normalizeHeatmapData.md) | Normalizes data specifically for heatmap charts. Expects data in format: `{ xKey: string, yAxisKey: string, valueKey: number }` | +| [Pagination](functions/Pagination.md) | - | +| [PaginationContent](functions/PaginationContent.md) | - | +| [PaginationEllipsis](functions/PaginationEllipsis.md) | - | +| [PaginationItem](functions/PaginationItem.md) | - | +| [PaginationLink](functions/PaginationLink.md) | - | +| [PaginationNext](functions/PaginationNext.md) | - | +| [PaginationPrevious](functions/PaginationPrevious.md) | - | +| [Popover](functions/Popover.md) | - | +| [PopoverAnchor](functions/PopoverAnchor.md) | - | +| [PopoverContent](functions/PopoverContent.md) | - | +| [PopoverTrigger](functions/PopoverTrigger.md) | - | +| [Progress](functions/Progress.md) | - | +| [RadioGroup](functions/RadioGroup.md) | - | +| [RadioGroupItem](functions/RadioGroupItem.md) | - | +| [ResizableHandle](functions/ResizableHandle.md) | - | +| [ResizablePanel](functions/ResizablePanel.md) | - | +| [ResizablePanelGroup](functions/ResizablePanelGroup.md) | - | +| [ScrollArea](functions/ScrollArea.md) | - | +| [ScrollBar](functions/ScrollBar.md) | - | +| [Select](functions/Select.md) | - | +| [SelectContent](functions/SelectContent.md) | - | +| [SelectGroup](functions/SelectGroup.md) | - | +| [SelectItem](functions/SelectItem.md) | - | +| [SelectLabel](functions/SelectLabel.md) | - | +| [SelectScrollDownButton](functions/SelectScrollDownButton.md) | - | +| [SelectScrollUpButton](functions/SelectScrollUpButton.md) | - | +| [SelectSeparator](functions/SelectSeparator.md) | - | +| [SelectTrigger](functions/SelectTrigger.md) | - | +| [SelectValue](functions/SelectValue.md) | - | +| [Separator](functions/Separator.md) | - | +| [Sheet](functions/Sheet.md) | - | +| [SheetClose](functions/SheetClose.md) | - | +| [SheetContent](functions/SheetContent.md) | - | +| [SheetDescription](functions/SheetDescription.md) | - | +| [SheetFooter](functions/SheetFooter.md) | - | +| [SheetHeader](functions/SheetHeader.md) | - | +| [SheetTitle](functions/SheetTitle.md) | - | +| [SheetTrigger](functions/SheetTrigger.md) | - | +| [Sidebar](functions/Sidebar.md) | - | +| [SidebarContent](functions/SidebarContent.md) | - | +| [SidebarFooter](functions/SidebarFooter.md) | - | +| [SidebarGroup](functions/SidebarGroup.md) | - | +| [SidebarGroupAction](functions/SidebarGroupAction.md) | - | +| [SidebarGroupContent](functions/SidebarGroupContent.md) | - | +| [SidebarGroupLabel](functions/SidebarGroupLabel.md) | - | +| [SidebarHeader](functions/SidebarHeader.md) | - | +| [SidebarInput](functions/SidebarInput.md) | - | +| [SidebarInset](functions/SidebarInset.md) | - | +| [SidebarMenu](functions/SidebarMenu.md) | - | +| [SidebarMenuAction](functions/SidebarMenuAction.md) | - | +| [SidebarMenuBadge](functions/SidebarMenuBadge.md) | - | +| [SidebarMenuButton](functions/SidebarMenuButton.md) | - | +| [SidebarMenuItem](functions/SidebarMenuItem.md) | - | +| [SidebarMenuSkeleton](functions/SidebarMenuSkeleton.md) | - | +| [SidebarMenuSub](functions/SidebarMenuSub.md) | - | +| [SidebarMenuSubButton](functions/SidebarMenuSubButton.md) | - | +| [SidebarMenuSubItem](functions/SidebarMenuSubItem.md) | - | +| [SidebarProvider](functions/SidebarProvider.md) | - | +| [SidebarRail](functions/SidebarRail.md) | - | +| [SidebarSeparator](functions/SidebarSeparator.md) | - | +| [SidebarTrigger](functions/SidebarTrigger.md) | - | +| [Skeleton](functions/Skeleton.md) | - | +| [Slider](functions/Slider.md) | - | +| [sortTimeSeriesAscending](functions/sortTimeSeriesAscending.md) | Sorts time-series data in ascending chronological order. | +| [Spinner](functions/Spinner.md) | - | +| [Switch](functions/Switch.md) | - | +| [Table](functions/Table.md) | - | +| [TableBody](functions/TableBody.md) | - | +| [TableCaption](functions/TableCaption.md) | - | +| [TableCell](functions/TableCell.md) | - | +| [TableFooter](functions/TableFooter.md) | - | +| [TableHead](functions/TableHead.md) | - | +| [TableHeader](functions/TableHeader.md) | - | +| [TableRow](functions/TableRow.md) | - | +| [Tabs](functions/Tabs.md) | - | +| [TabsContent](functions/TabsContent.md) | - | +| [TabsList](functions/TabsList.md) | - | +| [TabsTrigger](functions/TabsTrigger.md) | - | +| [Textarea](functions/Textarea.md) | - | +| [Toaster](functions/Toaster.md) | - | +| [toChartArray](functions/toChartArray.md) | Converts an array of values to chart-compatible types. | +| [toChartValue](functions/toChartValue.md) | Converts a value to a chart-compatible type. Handles BigInt conversion (Arrow can return BigInt64Array values). Handles Date objects by converting to timestamps. | +| [Toggle](functions/Toggle.md) | - | +| [ToggleGroup](functions/ToggleGroup.md) | - | +| [ToggleGroupItem](functions/ToggleGroupItem.md) | - | +| [Tooltip](functions/Tooltip.md) | - | +| [TooltipContent](functions/TooltipContent.md) | - | +| [TooltipProvider](functions/TooltipProvider.md) | - | +| [TooltipTrigger](functions/TooltipTrigger.md) | - | +| [truncateLabel](functions/truncateLabel.md) | Truncates a label to a maximum length with ellipsis. | +| [useAllThemeColors](functions/useAllThemeColors.md) | Hook to get all three color palettes at once. Useful when a component needs access to multiple palette types. | +| [useAnalyticsQuery](functions/useAnalyticsQuery.md) | Subscribe to an analytics query over SSE and returns its latest result. Integration hook between client and analytics plugin. | +| [useChartData](functions/useChartData.md) | Hook for fetching chart data in either JSON or Arrow format. Automatically selects the best format based on query hints. | +| [useFormField](functions/useFormField.md) | - | +| [useSidebar](functions/useSidebar.md) | - | +| [useThemeColors](functions/useThemeColors.md) | Hook to get theme colors with automatic updates on theme change. Re-resolves CSS variables when color scheme or theme attributes change. | diff --git a/docs/docs/api/appkit-ui/interfaces/AreaChartSpecificProps.md b/docs/docs/api/appkit-ui/interfaces/AreaChartSpecificProps.md new file mode 100644 index 0000000..ea82b71 --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/AreaChartSpecificProps.md @@ -0,0 +1,77 @@ +# Interface: AreaChartSpecificProps + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:139](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L139) + +Props specific to area charts + +## Properties + +### orientation? + +```ts +optional orientation: Orientation; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:141](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L141) + +Chart orientation + +#### Default + +```ts +"vertical" +``` + +*** + +### showSymbol? + +```ts +optional showSymbol: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:143](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L143) + +Show data point symbols + +#### Default + +```ts +false +``` + +*** + +### smooth? + +```ts +optional smooth: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:145](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L145) + +Smooth line curves + +#### Default + +```ts +true +``` + +*** + +### stacked? + +```ts +optional stacked: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:147](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L147) + +Stack areas + +#### Default + +```ts +false +``` diff --git a/docs/docs/api/appkit-ui/interfaces/BarChartSpecificProps.md b/docs/docs/api/appkit-ui/interfaces/BarChartSpecificProps.md new file mode 100644 index 0000000..b137c6b --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/BarChartSpecificProps.md @@ -0,0 +1,35 @@ +# Interface: BarChartSpecificProps + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:121](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L121) + +Props specific to bar charts + +## Properties + +### orientation? + +```ts +optional orientation: Orientation; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:123](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L123) + +Chart orientation + +#### Default + +```ts +"vertical" +``` + +*** + +### stacked? + +```ts +optional stacked: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:125](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L125) + +Stack bars diff --git a/docs/docs/api/appkit-ui/interfaces/BaseChartProps.md b/docs/docs/api/appkit-ui/interfaces/BaseChartProps.md new file mode 100644 index 0000000..c25ad38 --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/BaseChartProps.md @@ -0,0 +1,348 @@ +# Interface: BaseChartProps + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:43](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L43) + +## Properties + +### chartType + +```ts +chartType: ChartType; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:47](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L47) + +Chart type + +*** + +### className? + +```ts +optional className: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:94](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L94) + +Additional CSS classes + +*** + +### colorPalette? + +```ts +optional colorPalette: ChartColorPalette; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:66](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L66) + +Color palette to use. Auto-selected based on chart type if not specified. +- "categorical": Distinct colors for different categories (bar, pie, line) +- "sequential": Gradient for magnitude (heatmap) +- "diverging": Two-tone for positive/negative (correlation) + +*** + +### colors? + +```ts +optional colors: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:68](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L68) + +Custom colors (overrides colorPalette) + +*** + +### data + +```ts +data: ChartData; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:45](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L45) + +Chart data (Arrow Table or JSON array) - format is auto-detected + +*** + +### height? + +```ts +optional height: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:55](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L55) + +Chart height in pixels + +#### Default + +```ts +300 +``` + +*** + +### innerRadius? + +```ts +optional innerRadius: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:80](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L80) + +Inner radius for pie/donut (0-100) + +#### Default + +```ts +0 +``` + +*** + +### labelPosition? + +```ts +optional labelPosition: "outside" | "inside" | "center"; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:84](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L84) + +Label position for pie/donut + +#### Default + +```ts +"outside" +``` + +*** + +### max? + +```ts +optional max: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:90](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L90) + +Max value for heatmap color scale + +*** + +### min? + +```ts +optional min: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:88](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L88) + +Min value for heatmap color scale + +*** + +### options? + +```ts +optional options: Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:92](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L92) + +Additional ECharts options to merge + +*** + +### orientation? + +```ts +optional orientation: Orientation; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:53](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L53) + +Chart orientation + +#### Default + +```ts +"vertical" +``` + +*** + +### showArea? + +```ts +optional showArea: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:78](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L78) + +Show area fill for radar charts + +#### Default + +```ts +true +``` + +*** + +### showLabels? + +```ts +optional showLabels: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:82](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L82) + +Show labels on pie/donut slices + +#### Default + +```ts +true +``` + +*** + +### showLegend? + +```ts +optional showLegend: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:59](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L59) + +Show legend + +#### Default + +```ts +true +``` + +*** + +### showSymbol? + +```ts +optional showSymbol: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:70](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L70) + +Show data point symbols (line/area charts) + +#### Default + +```ts +false +``` + +*** + +### smooth? + +```ts +optional smooth: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:72](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L72) + +Smooth line curves (line/area charts) + +#### Default + +```ts +true +``` + +*** + +### stacked? + +```ts +optional stacked: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:74](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L74) + +Stack series + +#### Default + +```ts +false +``` + +*** + +### symbolSize? + +```ts +optional symbolSize: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:76](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L76) + +Symbol size for scatter charts + +#### Default + +```ts +8 +``` + +*** + +### title? + +```ts +optional title: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:57](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L57) + +Chart title + +*** + +### xKey? + +```ts +optional xKey: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:49](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L49) + +X-axis field key (auto-detected from schema if not provided) + +*** + +### yAxisKey? + +```ts +optional yAxisKey: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:86](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L86) + +Y-axis field key for heatmap (the row dimension) + +*** + +### yKey? + +```ts +optional yKey: string | string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/base.tsx:51](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/base.tsx#L51) + +Y-axis field key(s) (auto-detected from schema if not provided) diff --git a/docs/docs/api/appkit-ui/interfaces/CartesianContext.md b/docs/docs/api/appkit-ui/interfaces/CartesianContext.md new file mode 100644 index 0000000..b470881 --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/CartesianContext.md @@ -0,0 +1,151 @@ +# Interface: CartesianContext + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:17](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L17) + +## Extends + +- [`OptionBuilderContext`](OptionBuilderContext.md) + +## Properties + +### chartType + +```ts +chartType: ChartType; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:18](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L18) + +*** + +### colors + +```ts +colors: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:12](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L12) + +#### Inherited from + +[`OptionBuilderContext`](OptionBuilderContext.md).[`colors`](OptionBuilderContext.md#colors) + +*** + +### isTimeSeries + +```ts +isTimeSeries: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:19](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L19) + +*** + +### showLegend + +```ts +showLegend: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:14](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L14) + +#### Inherited from + +[`OptionBuilderContext`](OptionBuilderContext.md).[`showLegend`](OptionBuilderContext.md#showlegend) + +*** + +### showSymbol + +```ts +showSymbol: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:22](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L22) + +*** + +### smooth + +```ts +smooth: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:21](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L21) + +*** + +### stacked + +```ts +stacked: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:20](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L20) + +*** + +### symbolSize + +```ts +symbolSize: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:23](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L23) + +*** + +### title? + +```ts +optional title: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:13](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L13) + +#### Inherited from + +[`OptionBuilderContext`](OptionBuilderContext.md).[`title`](OptionBuilderContext.md#title) + +*** + +### xData + +```ts +xData: (string | number)[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:9](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L9) + +#### Inherited from + +[`OptionBuilderContext`](OptionBuilderContext.md).[`xData`](OptionBuilderContext.md#xdata) + +*** + +### yDataMap + +```ts +yDataMap: Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:10](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L10) + +#### Inherited from + +[`OptionBuilderContext`](OptionBuilderContext.md).[`yDataMap`](OptionBuilderContext.md#ydatamap) + +*** + +### yFields + +```ts +yFields: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:11](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L11) + +#### Inherited from + +[`OptionBuilderContext`](OptionBuilderContext.md).[`yFields`](OptionBuilderContext.md#yfields) diff --git a/docs/docs/api/appkit-ui/interfaces/ChartBaseProps.md b/docs/docs/api/appkit-ui/interfaces/ChartBaseProps.md new file mode 100644 index 0000000..3a15543 --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/ChartBaseProps.md @@ -0,0 +1,151 @@ +# Interface: ChartBaseProps + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:35](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L35) + +Common visual and behavior props for all charts + +## Extended by + +- [`DataProps`](DataProps.md) +- [`QueryProps`](QueryProps.md) + +## Properties + +### ariaLabel? + +```ts +optional ariaLabel: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:60](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L60) + +Accessibility label for screen readers + +*** + +### className? + +```ts +optional className: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:52](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L52) + +Additional CSS classes + +*** + +### colorPalette? + +```ts +optional colorPalette: ChartColorPalette; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:46](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L46) + +Color palette to use. Auto-selected based on chart type if not specified. +- "categorical": Distinct colors for different categories (bar, pie, line) +- "sequential": Gradient for magnitude/intensity (heatmap) +- "diverging": Two-tone for positive/negative values + +*** + +### colors? + +```ts +optional colors: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:48](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L48) + +Custom colors for series (overrides colorPalette) + +*** + +### height? + +```ts +optional height: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:50](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L50) + +Chart height in pixels + +#### Default + +```ts +300 +``` + +*** + +### options? + +```ts +optional options: Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:65](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L65) + +Additional ECharts options to merge + +*** + +### showLegend? + +```ts +optional showLegend: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:39](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L39) + +Show legend + +*** + +### testId? + +```ts +optional testId: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:62](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L62) + +Test ID for automated testing + +*** + +### title? + +```ts +optional title: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:37](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L37) + +Chart title + +*** + +### xKey? + +```ts +optional xKey: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:55](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L55) + +X-axis field key. Auto-detected from schema if not provided. + +*** + +### yKey? + +```ts +optional yKey: string | string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:57](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L57) + +Y-axis field key(s). Auto-detected from schema if not provided. diff --git a/docs/docs/api/appkit-ui/interfaces/DataProps.md b/docs/docs/api/appkit-ui/interfaces/DataProps.md new file mode 100644 index 0000000..a97126b --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/DataProps.md @@ -0,0 +1,246 @@ +# Interface: DataProps + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:98](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L98) + +Props for direct data injection + +## Extends + +- [`ChartBaseProps`](ChartBaseProps.md) + +## Properties + +### ariaLabel? + +```ts +optional ariaLabel: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:60](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L60) + +Accessibility label for screen readers + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`ariaLabel`](ChartBaseProps.md#arialabel) + +*** + +### className? + +```ts +optional className: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:52](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L52) + +Additional CSS classes + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`className`](ChartBaseProps.md#classname) + +*** + +### colorPalette? + +```ts +optional colorPalette: ChartColorPalette; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:46](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L46) + +Color palette to use. Auto-selected based on chart type if not specified. +- "categorical": Distinct colors for different categories (bar, pie, line) +- "sequential": Gradient for magnitude/intensity (heatmap) +- "diverging": Two-tone for positive/negative values + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`colorPalette`](ChartBaseProps.md#colorpalette) + +*** + +### colors? + +```ts +optional colors: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:48](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L48) + +Custom colors for series (overrides colorPalette) + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`colors`](ChartBaseProps.md#colors) + +*** + +### data + +```ts +data: ChartData; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:100](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L100) + +Arrow Table or JSON array + +*** + +### format? + +```ts +optional format: undefined; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:105](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L105) + +*** + +### height? + +```ts +optional height: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:50](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L50) + +Chart height in pixels + +#### Default + +```ts +300 +``` + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`height`](ChartBaseProps.md#height) + +*** + +### options? + +```ts +optional options: Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:65](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L65) + +Additional ECharts options to merge + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`options`](ChartBaseProps.md#options) + +*** + +### parameters? + +```ts +optional parameters: undefined; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:104](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L104) + +*** + +### queryKey? + +```ts +optional queryKey: undefined; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:103](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L103) + +*** + +### showLegend? + +```ts +optional showLegend: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:39](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L39) + +Show legend + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`showLegend`](ChartBaseProps.md#showlegend) + +*** + +### testId? + +```ts +optional testId: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:62](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L62) + +Test ID for automated testing + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`testId`](ChartBaseProps.md#testid) + +*** + +### title? + +```ts +optional title: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:37](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L37) + +Chart title + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`title`](ChartBaseProps.md#title) + +*** + +### transformer? + +```ts +optional transformer: undefined; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:106](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L106) + +*** + +### xKey? + +```ts +optional xKey: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:55](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L55) + +X-axis field key. Auto-detected from schema if not provided. + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`xKey`](ChartBaseProps.md#xkey) + +*** + +### yKey? + +```ts +optional yKey: string | string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:57](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L57) + +Y-axis field key(s). Auto-detected from schema if not provided. + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`yKey`](ChartBaseProps.md#ykey) diff --git a/docs/docs/api/appkit-ui/interfaces/HeatmapChartSpecificProps.md b/docs/docs/api/appkit-ui/interfaces/HeatmapChartSpecificProps.md new file mode 100644 index 0000000..2c5d23d --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/HeatmapChartSpecificProps.md @@ -0,0 +1,60 @@ +# Interface: HeatmapChartSpecificProps + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:173](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L173) + +Props specific to heatmap charts + +## Properties + +### max? + +```ts +optional max: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:182](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L182) + +Max value for color scale (auto-detected if not provided) + +*** + +### min? + +```ts +optional min: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:180](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L180) + +Min value for color scale (auto-detected if not provided) + +*** + +### showLabels? + +```ts +optional showLabels: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:184](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L184) + +Show value labels on cells + +#### Default + +```ts +false +``` + +*** + +### yAxisKey? + +```ts +optional yAxisKey: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:178](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L178) + +Field key for the Y-axis categories. +For heatmaps, data should have: xKey (column), yAxisKey (row), and yKey (value). diff --git a/docs/docs/api/appkit-ui/interfaces/HeatmapContext.md b/docs/docs/api/appkit-ui/interfaces/HeatmapContext.md new file mode 100644 index 0000000..342ca12 --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/HeatmapContext.md @@ -0,0 +1,151 @@ +# Interface: HeatmapContext + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:167](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L167) + +## Extends + +- [`OptionBuilderContext`](OptionBuilderContext.md) + +## Properties + +### colors + +```ts +colors: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:12](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L12) + +#### Inherited from + +[`OptionBuilderContext`](OptionBuilderContext.md).[`colors`](OptionBuilderContext.md#colors) + +*** + +### heatmapData + +```ts +heatmapData: [number, number, number][]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:171](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L171) + +Heatmap data as [xIndex, yIndex, value] tuples + +*** + +### max + +```ts +max: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:175](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L175) + +Max value for color scale + +*** + +### min + +```ts +min: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:173](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L173) + +Min value for color scale + +*** + +### showLabels + +```ts +showLabels: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:177](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L177) + +Show value labels on cells + +*** + +### showLegend + +```ts +showLegend: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:14](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L14) + +#### Inherited from + +[`OptionBuilderContext`](OptionBuilderContext.md).[`showLegend`](OptionBuilderContext.md#showlegend) + +*** + +### title? + +```ts +optional title: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:13](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L13) + +#### Inherited from + +[`OptionBuilderContext`](OptionBuilderContext.md).[`title`](OptionBuilderContext.md#title) + +*** + +### xData + +```ts +xData: (string | number)[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:9](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L9) + +#### Inherited from + +[`OptionBuilderContext`](OptionBuilderContext.md).[`xData`](OptionBuilderContext.md#xdata) + +*** + +### yAxisData + +```ts +yAxisData: (string | number)[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:169](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L169) + +Y-axis categories (rows) + +*** + +### yDataMap + +```ts +yDataMap: Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:10](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L10) + +#### Inherited from + +[`OptionBuilderContext`](OptionBuilderContext.md).[`yDataMap`](OptionBuilderContext.md#ydatamap) + +*** + +### yFields + +```ts +yFields: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:11](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L11) + +#### Inherited from + +[`OptionBuilderContext`](OptionBuilderContext.md).[`yFields`](OptionBuilderContext.md#yfields) diff --git a/docs/docs/api/appkit-ui/interfaces/LineChartSpecificProps.md b/docs/docs/api/appkit-ui/interfaces/LineChartSpecificProps.md new file mode 100644 index 0000000..19c4c19 --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/LineChartSpecificProps.md @@ -0,0 +1,59 @@ +# Interface: LineChartSpecificProps + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:129](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L129) + +Props specific to line charts + +## Properties + +### orientation? + +```ts +optional orientation: Orientation; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:131](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L131) + +Chart orientation + +#### Default + +```ts +"vertical" +``` + +*** + +### showSymbol? + +```ts +optional showSymbol: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:133](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L133) + +Show data point symbols + +#### Default + +```ts +false +``` + +*** + +### smooth? + +```ts +optional smooth: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:135](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L135) + +Smooth line curves + +#### Default + +```ts +true +``` diff --git a/docs/docs/api/appkit-ui/interfaces/NormalizedChartData.md b/docs/docs/api/appkit-ui/interfaces/NormalizedChartData.md new file mode 100644 index 0000000..7cf2c51 --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/NormalizedChartData.md @@ -0,0 +1,75 @@ +# Interface: NormalizedChartData + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:216](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L216) + +Normalized chart data for rendering (standard charts) + +## Extends + +- [`NormalizedChartDataBase`](NormalizedChartDataBase.md) + +## Properties + +### chartType + +```ts +chartType: "timeseries" | "categorical"; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:212](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L212) + +#### Inherited from + +[`NormalizedChartDataBase`](NormalizedChartDataBase.md).[`chartType`](NormalizedChartDataBase.md#charttype) + +*** + +### xData + +```ts +xData: (string | number)[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:209](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L209) + +#### Inherited from + +[`NormalizedChartDataBase`](NormalizedChartDataBase.md).[`xData`](NormalizedChartDataBase.md#xdata) + +*** + +### xField + +```ts +xField: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:210](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L210) + +#### Inherited from + +[`NormalizedChartDataBase`](NormalizedChartDataBase.md).[`xField`](NormalizedChartDataBase.md#xfield) + +*** + +### yDataMap + +```ts +yDataMap: Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:217](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L217) + +*** + +### yFields + +```ts +yFields: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:211](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L211) + +#### Inherited from + +[`NormalizedChartDataBase`](NormalizedChartDataBase.md).[`yFields`](NormalizedChartDataBase.md#yfields) diff --git a/docs/docs/api/appkit-ui/interfaces/NormalizedChartDataBase.md b/docs/docs/api/appkit-ui/interfaces/NormalizedChartDataBase.md new file mode 100644 index 0000000..abd5524 --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/NormalizedChartDataBase.md @@ -0,0 +1,50 @@ +# Interface: NormalizedChartDataBase + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:208](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L208) + +Base normalized data shared by all chart types + +## Extended by + +- [`NormalizedHeatmapData`](NormalizedHeatmapData.md) +- [`NormalizedChartData`](NormalizedChartData.md) + +## Properties + +### chartType + +```ts +chartType: "timeseries" | "categorical"; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:212](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L212) + +*** + +### xData + +```ts +xData: (string | number)[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:209](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L209) + +*** + +### xField + +```ts +xField: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:210](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L210) + +*** + +### yFields + +```ts +yFields: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:211](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L211) diff --git a/docs/docs/api/appkit-ui/interfaces/NormalizedHeatmapData.md b/docs/docs/api/appkit-ui/interfaces/NormalizedHeatmapData.md new file mode 100644 index 0000000..5e8b354 --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/NormalizedHeatmapData.md @@ -0,0 +1,115 @@ +# Interface: NormalizedHeatmapData + +Defined in: [packages/appkit-ui/src/react/charts/normalize.ts:306](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/normalize.ts#L306) + +Normalized data for heatmap charts. +Extends base (not NormalizedChartData) because heatmaps don't use yDataMap. +Instead, they use heatmapData which contains [xIndex, yIndex, value] tuples. + +## Extends + +- [`NormalizedChartDataBase`](NormalizedChartDataBase.md) + +## Properties + +### chartType + +```ts +chartType: "timeseries" | "categorical"; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:212](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L212) + +#### Inherited from + +[`NormalizedChartDataBase`](NormalizedChartDataBase.md).[`chartType`](NormalizedChartDataBase.md#charttype) + +*** + +### heatmapData + +```ts +heatmapData: [number, number, number][]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/normalize.ts:310](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/normalize.ts#L310) + +Heatmap data as [xIndex, yIndex, value] tuples + +*** + +### max + +```ts +max: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/normalize.ts:314](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/normalize.ts#L314) + +Max value in the data + +*** + +### min + +```ts +min: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/normalize.ts:312](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/normalize.ts#L312) + +Min value in the data + +*** + +### xData + +```ts +xData: (string | number)[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:209](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L209) + +#### Inherited from + +[`NormalizedChartDataBase`](NormalizedChartDataBase.md).[`xData`](NormalizedChartDataBase.md#xdata) + +*** + +### xField + +```ts +xField: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:210](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L210) + +#### Inherited from + +[`NormalizedChartDataBase`](NormalizedChartDataBase.md).[`xField`](NormalizedChartDataBase.md#xfield) + +*** + +### yAxisData + +```ts +yAxisData: (string | number)[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/normalize.ts:308](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/normalize.ts#L308) + +Y-axis categories (rows) + +*** + +### yFields + +```ts +yFields: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:211](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L211) + +#### Inherited from + +[`NormalizedChartDataBase`](NormalizedChartDataBase.md).[`yFields`](NormalizedChartDataBase.md#yfields) diff --git a/docs/docs/api/appkit-ui/interfaces/OptionBuilderContext.md b/docs/docs/api/appkit-ui/interfaces/OptionBuilderContext.md new file mode 100644 index 0000000..96a8a5f --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/OptionBuilderContext.md @@ -0,0 +1,68 @@ +# Interface: OptionBuilderContext + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L8) + +## Extended by + +- [`CartesianContext`](CartesianContext.md) +- [`HeatmapContext`](HeatmapContext.md) + +## Properties + +### colors + +```ts +colors: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:12](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L12) + +*** + +### showLegend + +```ts +showLegend: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:14](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L14) + +*** + +### title? + +```ts +optional title: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:13](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L13) + +*** + +### xData + +```ts +xData: (string | number)[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:9](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L9) + +*** + +### yDataMap + +```ts +yDataMap: Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:10](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L10) + +*** + +### yFields + +```ts +yFields: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/options.ts:11](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/options.ts#L11) diff --git a/docs/docs/api/appkit-ui/interfaces/PieChartSpecificProps.md b/docs/docs/api/appkit-ui/interfaces/PieChartSpecificProps.md new file mode 100644 index 0000000..611f89e --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/PieChartSpecificProps.md @@ -0,0 +1,59 @@ +# Interface: PieChartSpecificProps + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:157](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L157) + +Props specific to pie/donut charts + +## Properties + +### innerRadius? + +```ts +optional innerRadius: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:159](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L159) + +Inner radius for donut charts (0-100%) + +#### Default + +```ts +0 +``` + +*** + +### labelPosition? + +```ts +optional labelPosition: "outside" | "inside" | "center"; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:163](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L163) + +Label position + +#### Default + +```ts +"outside" +``` + +*** + +### showLabels? + +```ts +optional showLabels: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:161](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L161) + +Show labels on slices + +#### Default + +```ts +true +``` diff --git a/docs/docs/api/appkit-ui/interfaces/PluginRegistry.md b/docs/docs/api/appkit-ui/interfaces/PluginRegistry.md new file mode 100644 index 0000000..5c5adc1 --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/PluginRegistry.md @@ -0,0 +1,9 @@ +# Interface: PluginRegistry + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:134](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L134) + +## Indexable + +```ts +[key: string]: Record +``` diff --git a/docs/docs/api/appkit-ui/interfaces/QueryProps.md b/docs/docs/api/appkit-ui/interfaces/QueryProps.md new file mode 100644 index 0000000..4ef700f --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/QueryProps.md @@ -0,0 +1,277 @@ +# Interface: QueryProps + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:73](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L73) + +Props for query-based data fetching + +## Extends + +- [`ChartBaseProps`](ChartBaseProps.md) + +## Properties + +### ariaLabel? + +```ts +optional ariaLabel: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:60](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L60) + +Accessibility label for screen readers + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`ariaLabel`](ChartBaseProps.md#arialabel) + +*** + +### className? + +```ts +optional className: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:52](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L52) + +Additional CSS classes + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`className`](ChartBaseProps.md#classname) + +*** + +### colorPalette? + +```ts +optional colorPalette: ChartColorPalette; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:46](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L46) + +Color palette to use. Auto-selected based on chart type if not specified. +- "categorical": Distinct colors for different categories (bar, pie, line) +- "sequential": Gradient for magnitude/intensity (heatmap) +- "diverging": Two-tone for positive/negative values + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`colorPalette`](ChartBaseProps.md#colorpalette) + +*** + +### colors? + +```ts +optional colors: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:48](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L48) + +Custom colors for series (overrides colorPalette) + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`colors`](ChartBaseProps.md#colors) + +*** + +### data? + +```ts +optional data: undefined; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:90](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L90) + +*** + +### format? + +```ts +optional format: DataFormat; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:85](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L85) + +Data format to use +- "json": Use JSON format (smaller payloads, simpler) +- "arrow": Use Arrow format (faster for large datasets) +- "auto": Automatically select based on expected data size + +#### Default + +```ts +"auto" +``` + +*** + +### height? + +```ts +optional height: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:50](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L50) + +Chart height in pixels + +#### Default + +```ts +300 +``` + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`height`](ChartBaseProps.md#height) + +*** + +### options? + +```ts +optional options: Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:65](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L65) + +Additional ECharts options to merge + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`options`](ChartBaseProps.md#options) + +*** + +### parameters? + +```ts +optional parameters: Record; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:77](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L77) + +Query parameters passed to the analytics endpoint + +*** + +### queryKey + +```ts +queryKey: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:75](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L75) + +Analytics query key registered with analytics plugin + +*** + +### showLegend? + +```ts +optional showLegend: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:39](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L39) + +Show legend + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`showLegend`](ChartBaseProps.md#showlegend) + +*** + +### testId? + +```ts +optional testId: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:62](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L62) + +Test ID for automated testing + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`testId`](ChartBaseProps.md#testid) + +*** + +### title? + +```ts +optional title: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:37](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L37) + +Chart title + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`title`](ChartBaseProps.md#title) + +*** + +### transformer()? + +```ts +optional transformer: (data) => T; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:87](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L87) + +Transform raw data before rendering + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `T` | + +#### Returns + +`T` + +*** + +### xKey? + +```ts +optional xKey: string; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:55](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L55) + +X-axis field key. Auto-detected from schema if not provided. + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`xKey`](ChartBaseProps.md#xkey) + +*** + +### yKey? + +```ts +optional yKey: string | string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:57](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L57) + +Y-axis field key(s). Auto-detected from schema if not provided. + +#### Inherited from + +[`ChartBaseProps`](ChartBaseProps.md).[`yKey`](ChartBaseProps.md#ykey) diff --git a/docs/docs/api/appkit-ui/interfaces/QueryRegistry.md b/docs/docs/api/appkit-ui/interfaces/QueryRegistry.md new file mode 100644 index 0000000..3619fcd --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/QueryRegistry.md @@ -0,0 +1,27 @@ +# Interface: QueryRegistry + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:74](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L74) + +Query Registry for type-safe analytics queries. +Extend this interface via module augmentation to get full type inference: + +## Example + +```typescript +// config/appKitTypes.d.ts +declare module "@databricks/appkit-ui/react" { + interface QueryRegistry { + apps_list: { + name: "apps_list"; + parameters: { startDate: string; endDate: string; aggregationLevel: string }; + result: Array<{ id: string; name: string }>; + }; + } +} +``` + +## Indexable + +```ts +[key: string]: object +``` diff --git a/docs/docs/api/appkit-ui/interfaces/RadarChartSpecificProps.md b/docs/docs/api/appkit-ui/interfaces/RadarChartSpecificProps.md new file mode 100644 index 0000000..c6a691d --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/RadarChartSpecificProps.md @@ -0,0 +1,23 @@ +# Interface: RadarChartSpecificProps + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:167](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L167) + +Props specific to radar charts + +## Properties + +### showArea? + +```ts +optional showArea: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:169](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L169) + +Show area fill + +#### Default + +```ts +true +``` diff --git a/docs/docs/api/appkit-ui/interfaces/ScatterChartSpecificProps.md b/docs/docs/api/appkit-ui/interfaces/ScatterChartSpecificProps.md new file mode 100644 index 0000000..acfe75a --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/ScatterChartSpecificProps.md @@ -0,0 +1,23 @@ +# Interface: ScatterChartSpecificProps + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:151](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L151) + +Props specific to scatter charts + +## Properties + +### symbolSize? + +```ts +optional symbolSize: number; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:153](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L153) + +Symbol size + +#### Default + +```ts +8 +``` diff --git a/docs/docs/api/appkit-ui/interfaces/TypedArrowTable.md b/docs/docs/api/appkit-ui/interfaces/TypedArrowTable.md new file mode 100644 index 0000000..d2d9b0c --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/TypedArrowTable.md @@ -0,0 +1,36 @@ +# Interface: TypedArrowTable\ + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:20](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L20) + +Typed Arrow Table - preserves row type information for type inference. +At runtime this is just a regular Arrow Table, but TypeScript knows the row schema. + +## Example + +```typescript +type MyTable = TypedArrowTable<{ id: string; value: number }>; +// Can access table.getChild("id") knowing it exists +``` + +## Extends + +- `Table` + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `TRow` *extends* `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> | + +## Properties + +### \_\_rowType? + +```ts +readonly optional __rowType: TRow; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:27](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L27) + +Phantom type marker for row schema. +Not used at runtime - only for TypeScript type inference. diff --git a/docs/docs/api/appkit-ui/interfaces/UseAnalyticsQueryOptions.md b/docs/docs/api/appkit-ui/interfaces/UseAnalyticsQueryOptions.md new file mode 100644 index 0000000..168c442 --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/UseAnalyticsQueryOptions.md @@ -0,0 +1,47 @@ +# Interface: UseAnalyticsQueryOptions\ + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:35](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L35) + +Options for configuring an analytics SSE query + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `F` *extends* [`AnalyticsFormat`](../type-aliases/AnalyticsFormat.md) | `"JSON"` | + +## Properties + +### autoStart? + +```ts +optional autoStart: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:43](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L43) + +Whether to automatically start the query when the hook is mounted. Default is true. + +*** + +### format? + +```ts +optional format: F; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:37](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L37) + +Response format - "JSON" returns typed arrays, "ARROW" returns TypedArrowTable + +*** + +### maxParametersSize? + +```ts +optional maxParametersSize: number; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:40](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L40) + +Maximum size of serialized parameters in bytes diff --git a/docs/docs/api/appkit-ui/interfaces/UseAnalyticsQueryResult.md b/docs/docs/api/appkit-ui/interfaces/UseAnalyticsQueryResult.md new file mode 100644 index 0000000..edcb76d --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/UseAnalyticsQueryResult.md @@ -0,0 +1,47 @@ +# Interface: UseAnalyticsQueryResult\ + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:47](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L47) + +Result state returned by useAnalyticsQuery + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +## Properties + +### data + +```ts +data: T | null; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:49](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L49) + +Latest query result data + +*** + +### error + +```ts +error: string | null; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:53](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L53) + +Error state of the query + +*** + +### loading + +```ts +loading: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:51](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L51) + +Loading state of the query diff --git a/docs/docs/api/appkit-ui/interfaces/UseChartDataOptions.md b/docs/docs/api/appkit-ui/interfaces/UseChartDataOptions.md new file mode 100644 index 0000000..82135de --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/UseChartDataOptions.md @@ -0,0 +1,76 @@ +# Interface: UseChartDataOptions + +Defined in: [packages/appkit-ui/src/react/hooks/use-chart-data.ts:13](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/use-chart-data.ts#L13) + +## Properties + +### format? + +```ts +optional format: DataFormat; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/use-chart-data.ts:25](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/use-chart-data.ts#L25) + +Data format preference +- "json": Force JSON format +- "arrow": Force Arrow format +- "auto": Auto-select based on heuristics + +#### Default + +```ts +"auto" +``` + +*** + +### parameters? + +```ts +optional parameters: Record; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/use-chart-data.ts:17](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/use-chart-data.ts#L17) + +Query parameters + +*** + +### queryKey + +```ts +queryKey: string; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/use-chart-data.ts:15](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/use-chart-data.ts#L15) + +Analytics query key + +*** + +### transformer()? + +```ts +optional transformer: (data) => T; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/use-chart-data.ts:27](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/use-chart-data.ts#L27) + +Transform data after fetching + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `T` | + +#### Returns + +`T` diff --git a/docs/docs/api/appkit-ui/interfaces/UseChartDataResult.md b/docs/docs/api/appkit-ui/interfaces/UseChartDataResult.md new file mode 100644 index 0000000..9bacf23 --- /dev/null +++ b/docs/docs/api/appkit-ui/interfaces/UseChartDataResult.md @@ -0,0 +1,63 @@ +# Interface: UseChartDataResult + +Defined in: [packages/appkit-ui/src/react/hooks/use-chart-data.ts:30](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/use-chart-data.ts#L30) + +## Properties + +### data + +```ts +data: ChartData | null; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/use-chart-data.ts:32](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/use-chart-data.ts#L32) + +The fetched data (Arrow Table or JSON array) + +*** + +### error + +```ts +error: string | null; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/use-chart-data.ts:38](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/use-chart-data.ts#L38) + +Error message if any + +*** + +### isArrow + +```ts +isArrow: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/use-chart-data.ts:34](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/use-chart-data.ts#L34) + +Whether the data is in Arrow format + +*** + +### isEmpty + +```ts +isEmpty: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/use-chart-data.ts:40](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/use-chart-data.ts#L40) + +Whether the data is empty + +*** + +### loading + +```ts +loading: boolean; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/use-chart-data.ts:36](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/use-chart-data.ts#L36) + +Loading state diff --git a/docs/docs/api/appkit-ui/type-aliases/AnalyticsFormat.md b/docs/docs/api/appkit-ui/type-aliases/AnalyticsFormat.md new file mode 100644 index 0000000..106490f --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/AnalyticsFormat.md @@ -0,0 +1,9 @@ +# Type Alias: AnalyticsFormat + +```ts +type AnalyticsFormat = "JSON" | "ARROW"; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L8) + +Supported response formats for analytics queries diff --git a/docs/docs/api/appkit-ui/type-aliases/AreaChartProps.md b/docs/docs/api/appkit-ui/type-aliases/AreaChartProps.md new file mode 100644 index 0000000..c60ef34 --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/AreaChartProps.md @@ -0,0 +1,9 @@ +# Type Alias: AreaChartProps + +```ts +type AreaChartProps = + | QueryProps + | DataProps & AreaChartSpecificProps; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:193](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L193) diff --git a/docs/docs/api/appkit-ui/type-aliases/BarChartProps.md b/docs/docs/api/appkit-ui/type-aliases/BarChartProps.md new file mode 100644 index 0000000..852fdf0 --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/BarChartProps.md @@ -0,0 +1,9 @@ +# Type Alias: BarChartProps + +```ts +type BarChartProps = + | QueryProps + | DataProps & BarChartSpecificProps; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:191](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L191) diff --git a/docs/docs/api/appkit-ui/type-aliases/CarouselApi.md b/docs/docs/api/appkit-ui/type-aliases/CarouselApi.md new file mode 100644 index 0000000..328e1f3 --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/CarouselApi.md @@ -0,0 +1,7 @@ +# Type Alias: CarouselApi + +```ts +type CarouselApi = UseEmblaCarouselType[1]; +``` + +Defined in: [packages/appkit-ui/src/react/ui/carousel.tsx:10](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/carousel.tsx#L10) diff --git a/docs/docs/api/appkit-ui/type-aliases/ChartColorPalette.md b/docs/docs/api/appkit-ui/type-aliases/ChartColorPalette.md new file mode 100644 index 0000000..fd09753 --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/ChartColorPalette.md @@ -0,0 +1,9 @@ +# Type Alias: ChartColorPalette + +```ts +type ChartColorPalette = "categorical" | "sequential" | "diverging"; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:32](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L32) + +Color palette types for different visualization needs diff --git a/docs/docs/api/appkit-ui/type-aliases/ChartConfig.md b/docs/docs/api/appkit-ui/type-aliases/ChartConfig.md new file mode 100644 index 0000000..d2a7d44 --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/ChartConfig.md @@ -0,0 +1,7 @@ +# Type Alias: ChartConfig + +```ts +type ChartConfig = { [k in string]: { icon?: React.ComponentType; label?: React.ReactNode } & ({ color?: string; theme?: never } | { color?: never; theme: Record }) }; +``` + +Defined in: [packages/appkit-ui/src/react/ui/chart.tsx:11](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/chart.tsx#L11) diff --git a/docs/docs/api/appkit-ui/type-aliases/ChartData.md b/docs/docs/api/appkit-ui/type-aliases/ChartData.md new file mode 100644 index 0000000..49ddc5b --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/ChartData.md @@ -0,0 +1,9 @@ +# Type Alias: ChartData + +```ts +type ChartData = Table | Record[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:25](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L25) + +Data that can be passed to unified charts diff --git a/docs/docs/api/appkit-ui/type-aliases/ChartType.md b/docs/docs/api/appkit-ui/type-aliases/ChartType.md new file mode 100644 index 0000000..3f0230a --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/ChartType.md @@ -0,0 +1,9 @@ +# Type Alias: ChartType + +```ts +type ChartType = "bar" | "line" | "area" | "pie" | "donut" | "scatter" | "radar" | "heatmap"; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:14](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L14) + +Supported chart types diff --git a/docs/docs/api/appkit-ui/type-aliases/ChartWrapperProps.md b/docs/docs/api/appkit-ui/type-aliases/ChartWrapperProps.md new file mode 100644 index 0000000..acdabfb --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/ChartWrapperProps.md @@ -0,0 +1,7 @@ +# Type Alias: ChartWrapperProps + +```ts +type ChartWrapperProps = CommonProps & ChartWrapperQueryProps | ChartWrapperDataProps; +``` + +Defined in: [packages/appkit-ui/src/react/charts/wrapper.tsx:50](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/wrapper.tsx#L50) diff --git a/docs/docs/api/appkit-ui/type-aliases/DataFormat.md b/docs/docs/api/appkit-ui/type-aliases/DataFormat.md new file mode 100644 index 0000000..8527362 --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/DataFormat.md @@ -0,0 +1,9 @@ +# Type Alias: DataFormat + +```ts +type DataFormat = "json" | "arrow" | "auto"; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L8) + +Supported data formats for analytics queries diff --git a/docs/docs/api/appkit-ui/type-aliases/DonutChartProps.md b/docs/docs/api/appkit-ui/type-aliases/DonutChartProps.md new file mode 100644 index 0000000..808caf4 --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/DonutChartProps.md @@ -0,0 +1,9 @@ +# Type Alias: DonutChartProps + +```ts +type DonutChartProps = + | QueryProps + | DataProps & PieChartSpecificProps; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:197](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L197) diff --git a/docs/docs/api/appkit-ui/type-aliases/HeatmapChartProps.md b/docs/docs/api/appkit-ui/type-aliases/HeatmapChartProps.md new file mode 100644 index 0000000..7af9fdd --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/HeatmapChartProps.md @@ -0,0 +1,9 @@ +# Type Alias: HeatmapChartProps + +```ts +type HeatmapChartProps = + | QueryProps + | DataProps & HeatmapChartSpecificProps; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:200](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L200) diff --git a/docs/docs/api/appkit-ui/type-aliases/InferResultByFormat.md b/docs/docs/api/appkit-ui/type-aliases/InferResultByFormat.md new file mode 100644 index 0000000..4d5f9be --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/InferResultByFormat.md @@ -0,0 +1,19 @@ +# Type Alias: InferResultByFormat\ + +```ts +type InferResultByFormat = F extends "ARROW" ? TypedArrowTable> : InferResult; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:119](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L119) + +Conditionally infers result type based on format. +- JSON format: Returns the typed array from QueryRegistry +- ARROW format: Returns TypedArrowTable with row type preserved + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | +| `K` | +| `F` *extends* [`AnalyticsFormat`](AnalyticsFormat.md) | diff --git a/docs/docs/api/appkit-ui/type-aliases/InferRowType.md b/docs/docs/api/appkit-ui/type-aliases/InferRowType.md new file mode 100644 index 0000000..e7b483f --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/InferRowType.md @@ -0,0 +1,16 @@ +# Type Alias: InferRowType\ + +```ts +type InferRowType = K extends AugmentedRegistry ? QueryRegistry[K] extends object ? R extends Record ? R : Record : Record : Record; +``` + +Defined in: [packages/appkit-ui/src/react/hooks/types.ts:106](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/hooks/types.ts#L106) + +Infers the row type from a query result array. +Used for TypedArrowTable row typing. + +## Type Parameters + +| Type Parameter | +| ------ | +| `K` | diff --git a/docs/docs/api/appkit-ui/type-aliases/LineChartProps.md b/docs/docs/api/appkit-ui/type-aliases/LineChartProps.md new file mode 100644 index 0000000..e7c3778 --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/LineChartProps.md @@ -0,0 +1,9 @@ +# Type Alias: LineChartProps + +```ts +type LineChartProps = + | QueryProps + | DataProps & LineChartSpecificProps; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:192](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L192) diff --git a/docs/docs/api/appkit-ui/type-aliases/Orientation.md b/docs/docs/api/appkit-ui/type-aliases/Orientation.md new file mode 100644 index 0000000..3f082a5 --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/Orientation.md @@ -0,0 +1,9 @@ +# Type Alias: Orientation + +```ts +type Orientation = "vertical" | "horizontal"; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:11](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L11) + +Chart orientation diff --git a/docs/docs/api/appkit-ui/type-aliases/PieChartProps.md b/docs/docs/api/appkit-ui/type-aliases/PieChartProps.md new file mode 100644 index 0000000..53cbf03 --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/PieChartProps.md @@ -0,0 +1,9 @@ +# Type Alias: PieChartProps + +```ts +type PieChartProps = + | QueryProps + | DataProps & PieChartSpecificProps; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:196](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L196) diff --git a/docs/docs/api/appkit-ui/type-aliases/RadarChartProps.md b/docs/docs/api/appkit-ui/type-aliases/RadarChartProps.md new file mode 100644 index 0000000..749cf29 --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/RadarChartProps.md @@ -0,0 +1,9 @@ +# Type Alias: RadarChartProps + +```ts +type RadarChartProps = + | QueryProps + | DataProps & RadarChartSpecificProps; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:198](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L198) diff --git a/docs/docs/api/appkit-ui/type-aliases/ScatterChartProps.md b/docs/docs/api/appkit-ui/type-aliases/ScatterChartProps.md new file mode 100644 index 0000000..cdfa6bb --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/ScatterChartProps.md @@ -0,0 +1,9 @@ +# Type Alias: ScatterChartProps + +```ts +type ScatterChartProps = + | QueryProps + | DataProps & ScatterChartSpecificProps; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:194](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L194) diff --git a/docs/docs/api/appkit-ui/type-aliases/UnifiedChartProps.md b/docs/docs/api/appkit-ui/type-aliases/UnifiedChartProps.md new file mode 100644 index 0000000..530c1a3 --- /dev/null +++ b/docs/docs/api/appkit-ui/type-aliases/UnifiedChartProps.md @@ -0,0 +1,11 @@ +# Type Alias: UnifiedChartProps + +```ts +type UnifiedChartProps = + | QueryProps + | DataProps; +``` + +Defined in: [packages/appkit-ui/src/react/charts/types.ts:114](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/types.ts#L114) + +Base union type - either query-based or data-based diff --git a/docs/docs/api/appkit-ui/typedoc-sidebar.ts b/docs/docs/api/appkit-ui/typedoc-sidebar.ts new file mode 100644 index 0000000..2c288aa --- /dev/null +++ b/docs/docs/api/appkit-ui/typedoc-sidebar.ts @@ -0,0 +1,1885 @@ +import { SidebarsConfig } from "@docusaurus/plugin-content-docs"; +const typedocSidebar: SidebarsConfig = { + items: [ + { + type: "category", + label: "Interfaces", + items: [ + { + type: "doc", + id: "api/appkit-ui/interfaces/AreaChartSpecificProps", + label: "AreaChartSpecificProps" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/BarChartSpecificProps", + label: "BarChartSpecificProps" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/BaseChartProps", + label: "BaseChartProps" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/CartesianContext", + label: "CartesianContext" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/ChartBaseProps", + label: "ChartBaseProps" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/DataProps", + label: "DataProps" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/HeatmapChartSpecificProps", + label: "HeatmapChartSpecificProps" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/HeatmapContext", + label: "HeatmapContext" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/LineChartSpecificProps", + label: "LineChartSpecificProps" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/NormalizedChartData", + label: "NormalizedChartData" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/NormalizedChartDataBase", + label: "NormalizedChartDataBase" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/NormalizedHeatmapData", + label: "NormalizedHeatmapData" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/OptionBuilderContext", + label: "OptionBuilderContext" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/PieChartSpecificProps", + label: "PieChartSpecificProps" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/PluginRegistry", + label: "PluginRegistry" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/QueryProps", + label: "QueryProps" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/QueryRegistry", + label: "QueryRegistry" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/RadarChartSpecificProps", + label: "RadarChartSpecificProps" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/ScatterChartSpecificProps", + label: "ScatterChartSpecificProps" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/TypedArrowTable", + label: "TypedArrowTable" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/UseAnalyticsQueryOptions", + label: "UseAnalyticsQueryOptions" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/UseAnalyticsQueryResult", + label: "UseAnalyticsQueryResult" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/UseChartDataOptions", + label: "UseChartDataOptions" + }, + { + type: "doc", + id: "api/appkit-ui/interfaces/UseChartDataResult", + label: "UseChartDataResult" + } + ] + }, + { + type: "category", + label: "Type Aliases", + items: [ + { + type: "doc", + id: "api/appkit-ui/type-aliases/AnalyticsFormat", + label: "AnalyticsFormat" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/AreaChartProps", + label: "AreaChartProps" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/BarChartProps", + label: "BarChartProps" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/CarouselApi", + label: "CarouselApi" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/ChartColorPalette", + label: "ChartColorPalette" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/ChartConfig", + label: "ChartConfig" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/ChartData", + label: "ChartData" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/ChartType", + label: "ChartType" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/ChartWrapperProps", + label: "ChartWrapperProps" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/DataFormat", + label: "DataFormat" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/DonutChartProps", + label: "DonutChartProps" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/HeatmapChartProps", + label: "HeatmapChartProps" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/InferResultByFormat", + label: "InferResultByFormat" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/InferRowType", + label: "InferRowType" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/LineChartProps", + label: "LineChartProps" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/Orientation", + label: "Orientation" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/PieChartProps", + label: "PieChartProps" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/RadarChartProps", + label: "RadarChartProps" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/ScatterChartProps", + label: "ScatterChartProps" + }, + { + type: "doc", + id: "api/appkit-ui/type-aliases/UnifiedChartProps", + label: "UnifiedChartProps" + } + ] + }, + { + type: "category", + label: "Variables", + items: [ + { + type: "doc", + id: "api/appkit-ui/variables/AreaChart", + label: "AreaChart" + }, + { + type: "doc", + id: "api/appkit-ui/variables/badgeVariants", + label: "badgeVariants" + }, + { + type: "doc", + id: "api/appkit-ui/variables/BarChart", + label: "BarChart" + }, + { + type: "doc", + id: "api/appkit-ui/variables/buttonGroupVariants", + label: "buttonGroupVariants" + }, + { + type: "doc", + id: "api/appkit-ui/variables/buttonVariants", + label: "buttonVariants" + }, + { + type: "doc", + id: "api/appkit-ui/variables/CHART_COLOR_VARS", + label: "CHART_COLOR_VARS" + }, + { + type: "doc", + id: "api/appkit-ui/variables/CHART_COLOR_VARS_CATEGORICAL", + label: "CHART_COLOR_VARS_CATEGORICAL" + }, + { + type: "doc", + id: "api/appkit-ui/variables/CHART_COLOR_VARS_DIVERGING", + label: "CHART_COLOR_VARS_DIVERGING" + }, + { + type: "doc", + id: "api/appkit-ui/variables/CHART_COLOR_VARS_SEQUENTIAL", + label: "CHART_COLOR_VARS_SEQUENTIAL" + }, + { + type: "doc", + id: "api/appkit-ui/variables/ChartLegend", + label: "ChartLegend" + }, + { + type: "doc", + id: "api/appkit-ui/variables/ChartTooltip", + label: "ChartTooltip" + }, + { + type: "doc", + id: "api/appkit-ui/variables/DATE_FIELD_PATTERNS", + label: "DATE_FIELD_PATTERNS" + }, + { + type: "doc", + id: "api/appkit-ui/variables/DonutChart", + label: "DonutChart" + }, + { + type: "doc", + id: "api/appkit-ui/variables/FALLBACK_COLORS", + label: "FALLBACK_COLORS" + }, + { + type: "doc", + id: "api/appkit-ui/variables/FALLBACK_COLORS_CATEGORICAL", + label: "FALLBACK_COLORS_CATEGORICAL" + }, + { + type: "doc", + id: "api/appkit-ui/variables/FALLBACK_COLORS_DIVERGING", + label: "FALLBACK_COLORS_DIVERGING" + }, + { + type: "doc", + id: "api/appkit-ui/variables/FALLBACK_COLORS_SEQUENTIAL", + label: "FALLBACK_COLORS_SEQUENTIAL" + }, + { + type: "doc", + id: "api/appkit-ui/variables/Form", + label: "Form" + }, + { + type: "doc", + id: "api/appkit-ui/variables/HeatmapChart", + label: "HeatmapChart" + }, + { + type: "doc", + id: "api/appkit-ui/variables/LineChart", + label: "LineChart" + }, + { + type: "doc", + id: "api/appkit-ui/variables/METADATA_DATE_PATTERNS", + label: "METADATA_DATE_PATTERNS" + }, + { + type: "doc", + id: "api/appkit-ui/variables/NAME_FIELD_PATTERNS", + label: "NAME_FIELD_PATTERNS" + }, + { + type: "doc", + id: "api/appkit-ui/variables/navigationMenuTriggerStyle", + label: "navigationMenuTriggerStyle" + }, + { + type: "doc", + id: "api/appkit-ui/variables/PieChart", + label: "PieChart" + }, + { + type: "doc", + id: "api/appkit-ui/variables/RadarChart", + label: "RadarChart" + }, + { + type: "doc", + id: "api/appkit-ui/variables/ScatterChart", + label: "ScatterChart" + }, + { + type: "doc", + id: "api/appkit-ui/variables/toggleVariants", + label: "toggleVariants" + } + ] + }, + { + type: "category", + label: "Functions", + items: [ + { + type: "doc", + id: "api/appkit-ui/functions/Accordion", + label: "Accordion" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AccordionContent", + label: "AccordionContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AccordionItem", + label: "AccordionItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AccordionTrigger", + label: "AccordionTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Alert", + label: "Alert" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AlertDescription", + label: "AlertDescription" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AlertDialog", + label: "AlertDialog" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AlertDialogAction", + label: "AlertDialogAction" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AlertDialogCancel", + label: "AlertDialogCancel" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AlertDialogContent", + label: "AlertDialogContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AlertDialogDescription", + label: "AlertDialogDescription" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AlertDialogFooter", + label: "AlertDialogFooter" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AlertDialogHeader", + label: "AlertDialogHeader" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AlertDialogOverlay", + label: "AlertDialogOverlay" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AlertDialogPortal", + label: "AlertDialogPortal" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AlertDialogTitle", + label: "AlertDialogTitle" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AlertDialogTrigger", + label: "AlertDialogTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AlertTitle", + label: "AlertTitle" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AspectRatio", + label: "AspectRatio" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Avatar", + label: "Avatar" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AvatarFallback", + label: "AvatarFallback" + }, + { + type: "doc", + id: "api/appkit-ui/functions/AvatarImage", + label: "AvatarImage" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Badge", + label: "Badge" + }, + { + type: "doc", + id: "api/appkit-ui/functions/BaseChart", + label: "BaseChart" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Breadcrumb", + label: "Breadcrumb" + }, + { + type: "doc", + id: "api/appkit-ui/functions/BreadcrumbEllipsis", + label: "BreadcrumbEllipsis" + }, + { + type: "doc", + id: "api/appkit-ui/functions/BreadcrumbItem", + label: "BreadcrumbItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/BreadcrumbLink", + label: "BreadcrumbLink" + }, + { + type: "doc", + id: "api/appkit-ui/functions/BreadcrumbList", + label: "BreadcrumbList" + }, + { + type: "doc", + id: "api/appkit-ui/functions/BreadcrumbPage", + label: "BreadcrumbPage" + }, + { + type: "doc", + id: "api/appkit-ui/functions/BreadcrumbSeparator", + label: "BreadcrumbSeparator" + }, + { + type: "doc", + id: "api/appkit-ui/functions/buildCartesianOption", + label: "buildCartesianOption" + }, + { + type: "doc", + id: "api/appkit-ui/functions/buildHeatmapOption", + label: "buildHeatmapOption" + }, + { + type: "doc", + id: "api/appkit-ui/functions/buildHorizontalBarOption", + label: "buildHorizontalBarOption" + }, + { + type: "doc", + id: "api/appkit-ui/functions/buildPieOption", + label: "buildPieOption" + }, + { + type: "doc", + id: "api/appkit-ui/functions/buildRadarOption", + label: "buildRadarOption" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Button", + label: "Button" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ButtonGroup", + label: "ButtonGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ButtonGroupSeparator", + label: "ButtonGroupSeparator" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ButtonGroupText", + label: "ButtonGroupText" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Calendar", + label: "Calendar" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CalendarDayButton", + label: "CalendarDayButton" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Card", + label: "Card" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CardAction", + label: "CardAction" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CardContent", + label: "CardContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CardDescription", + label: "CardDescription" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CardFooter", + label: "CardFooter" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CardHeader", + label: "CardHeader" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CardTitle", + label: "CardTitle" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Carousel", + label: "Carousel" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CarouselContent", + label: "CarouselContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CarouselItem", + label: "CarouselItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CarouselNext", + label: "CarouselNext" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CarouselPrevious", + label: "CarouselPrevious" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ChartContainer", + label: "ChartContainer" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ChartLegendContent", + label: "ChartLegendContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ChartStyle", + label: "ChartStyle" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ChartTooltipContent", + label: "ChartTooltipContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ChartWrapper", + label: "ChartWrapper" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Checkbox", + label: "Checkbox" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Collapsible", + label: "Collapsible" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CollapsibleContent", + label: "CollapsibleContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CollapsibleTrigger", + label: "CollapsibleTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Command", + label: "Command" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CommandDialog", + label: "CommandDialog" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CommandEmpty", + label: "CommandEmpty" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CommandGroup", + label: "CommandGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CommandInput", + label: "CommandInput" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CommandItem", + label: "CommandItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CommandList", + label: "CommandList" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CommandSeparator", + label: "CommandSeparator" + }, + { + type: "doc", + id: "api/appkit-ui/functions/CommandShortcut", + label: "CommandShortcut" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenu", + label: "ContextMenu" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuCheckboxItem", + label: "ContextMenuCheckboxItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuContent", + label: "ContextMenuContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuGroup", + label: "ContextMenuGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuItem", + label: "ContextMenuItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuLabel", + label: "ContextMenuLabel" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuPortal", + label: "ContextMenuPortal" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuRadioGroup", + label: "ContextMenuRadioGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuRadioItem", + label: "ContextMenuRadioItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuSeparator", + label: "ContextMenuSeparator" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuShortcut", + label: "ContextMenuShortcut" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuSub", + label: "ContextMenuSub" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuSubContent", + label: "ContextMenuSubContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuSubTrigger", + label: "ContextMenuSubTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ContextMenuTrigger", + label: "ContextMenuTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/createChart", + label: "createChart" + }, + { + type: "doc", + id: "api/appkit-ui/functions/createTimeSeriesData", + label: "createTimeSeriesData" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DataTable", + label: "DataTable" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Dialog", + label: "Dialog" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DialogClose", + label: "DialogClose" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DialogContent", + label: "DialogContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DialogDescription", + label: "DialogDescription" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DialogFooter", + label: "DialogFooter" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DialogHeader", + label: "DialogHeader" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DialogOverlay", + label: "DialogOverlay" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DialogPortal", + label: "DialogPortal" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DialogTitle", + label: "DialogTitle" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DialogTrigger", + label: "DialogTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Drawer", + label: "Drawer" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DrawerClose", + label: "DrawerClose" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DrawerContent", + label: "DrawerContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DrawerDescription", + label: "DrawerDescription" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DrawerFooter", + label: "DrawerFooter" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DrawerHeader", + label: "DrawerHeader" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DrawerOverlay", + label: "DrawerOverlay" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DrawerPortal", + label: "DrawerPortal" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DrawerTitle", + label: "DrawerTitle" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DrawerTrigger", + label: "DrawerTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenu", + label: "DropdownMenu" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuCheckboxItem", + label: "DropdownMenuCheckboxItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuContent", + label: "DropdownMenuContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuGroup", + label: "DropdownMenuGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuItem", + label: "DropdownMenuItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuLabel", + label: "DropdownMenuLabel" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuPortal", + label: "DropdownMenuPortal" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuRadioGroup", + label: "DropdownMenuRadioGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuRadioItem", + label: "DropdownMenuRadioItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuSeparator", + label: "DropdownMenuSeparator" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuShortcut", + label: "DropdownMenuShortcut" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuSub", + label: "DropdownMenuSub" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuSubContent", + label: "DropdownMenuSubContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuSubTrigger", + label: "DropdownMenuSubTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/DropdownMenuTrigger", + label: "DropdownMenuTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Empty", + label: "Empty" + }, + { + type: "doc", + id: "api/appkit-ui/functions/EmptyContent", + label: "EmptyContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/EmptyDescription", + label: "EmptyDescription" + }, + { + type: "doc", + id: "api/appkit-ui/functions/EmptyHeader", + label: "EmptyHeader" + }, + { + type: "doc", + id: "api/appkit-ui/functions/EmptyMedia", + label: "EmptyMedia" + }, + { + type: "doc", + id: "api/appkit-ui/functions/EmptyTitle", + label: "EmptyTitle" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Field", + label: "Field" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FieldContent", + label: "FieldContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FieldDescription", + label: "FieldDescription" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FieldError", + label: "FieldError" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FieldGroup", + label: "FieldGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FieldLabel", + label: "FieldLabel" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FieldLegend", + label: "FieldLegend" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FieldSeparator", + label: "FieldSeparator" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FieldSet", + label: "FieldSet" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FieldTitle", + label: "FieldTitle" + }, + { + type: "doc", + id: "api/appkit-ui/functions/formatLabel", + label: "formatLabel" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FormControl", + label: "FormControl" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FormDescription", + label: "FormDescription" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FormField", + label: "FormField" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FormItem", + label: "FormItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FormLabel", + label: "FormLabel" + }, + { + type: "doc", + id: "api/appkit-ui/functions/FormMessage", + label: "FormMessage" + }, + { + type: "doc", + id: "api/appkit-ui/functions/HoverCard", + label: "HoverCard" + }, + { + type: "doc", + id: "api/appkit-ui/functions/HoverCardContent", + label: "HoverCardContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/HoverCardTrigger", + label: "HoverCardTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Input", + label: "Input" + }, + { + type: "doc", + id: "api/appkit-ui/functions/InputGroup", + label: "InputGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/InputGroupAddon", + label: "InputGroupAddon" + }, + { + type: "doc", + id: "api/appkit-ui/functions/InputGroupButton", + label: "InputGroupButton" + }, + { + type: "doc", + id: "api/appkit-ui/functions/InputGroupInput", + label: "InputGroupInput" + }, + { + type: "doc", + id: "api/appkit-ui/functions/InputGroupText", + label: "InputGroupText" + }, + { + type: "doc", + id: "api/appkit-ui/functions/InputGroupTextarea", + label: "InputGroupTextarea" + }, + { + type: "doc", + id: "api/appkit-ui/functions/InputOTP", + label: "InputOTP" + }, + { + type: "doc", + id: "api/appkit-ui/functions/InputOTPGroup", + label: "InputOTPGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/InputOTPSeparator", + label: "InputOTPSeparator" + }, + { + type: "doc", + id: "api/appkit-ui/functions/InputOTPSlot", + label: "InputOTPSlot" + }, + { + type: "doc", + id: "api/appkit-ui/functions/isArrowTable", + label: "isArrowTable" + }, + { + type: "doc", + id: "api/appkit-ui/functions/isDataProps", + label: "isDataProps" + }, + { + type: "doc", + id: "api/appkit-ui/functions/isQueryProps", + label: "isQueryProps" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Item", + label: "Item" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ItemActions", + label: "ItemActions" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ItemContent", + label: "ItemContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ItemDescription", + label: "ItemDescription" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ItemFooter", + label: "ItemFooter" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ItemGroup", + label: "ItemGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ItemHeader", + label: "ItemHeader" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ItemMedia", + label: "ItemMedia" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ItemSeparator", + label: "ItemSeparator" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ItemTitle", + label: "ItemTitle" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Kbd", + label: "Kbd" + }, + { + type: "doc", + id: "api/appkit-ui/functions/KbdGroup", + label: "KbdGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Label", + label: "Label" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Menubar", + label: "Menubar" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarCheckboxItem", + label: "MenubarCheckboxItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarContent", + label: "MenubarContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarGroup", + label: "MenubarGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarItem", + label: "MenubarItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarLabel", + label: "MenubarLabel" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarMenu", + label: "MenubarMenu" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarPortal", + label: "MenubarPortal" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarRadioGroup", + label: "MenubarRadioGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarRadioItem", + label: "MenubarRadioItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarSeparator", + label: "MenubarSeparator" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarShortcut", + label: "MenubarShortcut" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarSub", + label: "MenubarSub" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarSubContent", + label: "MenubarSubContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarSubTrigger", + label: "MenubarSubTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/MenubarTrigger", + label: "MenubarTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/NavigationMenu", + label: "NavigationMenu" + }, + { + type: "doc", + id: "api/appkit-ui/functions/NavigationMenuContent", + label: "NavigationMenuContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/NavigationMenuIndicator", + label: "NavigationMenuIndicator" + }, + { + type: "doc", + id: "api/appkit-ui/functions/NavigationMenuItem", + label: "NavigationMenuItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/NavigationMenuLink", + label: "NavigationMenuLink" + }, + { + type: "doc", + id: "api/appkit-ui/functions/NavigationMenuList", + label: "NavigationMenuList" + }, + { + type: "doc", + id: "api/appkit-ui/functions/NavigationMenuTrigger", + label: "NavigationMenuTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/NavigationMenuViewport", + label: "NavigationMenuViewport" + }, + { + type: "doc", + id: "api/appkit-ui/functions/normalizeChartData", + label: "normalizeChartData" + }, + { + type: "doc", + id: "api/appkit-ui/functions/normalizeHeatmapData", + label: "normalizeHeatmapData" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Pagination", + label: "Pagination" + }, + { + type: "doc", + id: "api/appkit-ui/functions/PaginationContent", + label: "PaginationContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/PaginationEllipsis", + label: "PaginationEllipsis" + }, + { + type: "doc", + id: "api/appkit-ui/functions/PaginationItem", + label: "PaginationItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/PaginationLink", + label: "PaginationLink" + }, + { + type: "doc", + id: "api/appkit-ui/functions/PaginationNext", + label: "PaginationNext" + }, + { + type: "doc", + id: "api/appkit-ui/functions/PaginationPrevious", + label: "PaginationPrevious" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Popover", + label: "Popover" + }, + { + type: "doc", + id: "api/appkit-ui/functions/PopoverAnchor", + label: "PopoverAnchor" + }, + { + type: "doc", + id: "api/appkit-ui/functions/PopoverContent", + label: "PopoverContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/PopoverTrigger", + label: "PopoverTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Progress", + label: "Progress" + }, + { + type: "doc", + id: "api/appkit-ui/functions/RadioGroup", + label: "RadioGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/RadioGroupItem", + label: "RadioGroupItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ResizableHandle", + label: "ResizableHandle" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ResizablePanel", + label: "ResizablePanel" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ResizablePanelGroup", + label: "ResizablePanelGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ScrollArea", + label: "ScrollArea" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ScrollBar", + label: "ScrollBar" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Select", + label: "Select" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SelectContent", + label: "SelectContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SelectGroup", + label: "SelectGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SelectItem", + label: "SelectItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SelectLabel", + label: "SelectLabel" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SelectScrollDownButton", + label: "SelectScrollDownButton" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SelectScrollUpButton", + label: "SelectScrollUpButton" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SelectSeparator", + label: "SelectSeparator" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SelectTrigger", + label: "SelectTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SelectValue", + label: "SelectValue" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Separator", + label: "Separator" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Sheet", + label: "Sheet" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SheetClose", + label: "SheetClose" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SheetContent", + label: "SheetContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SheetDescription", + label: "SheetDescription" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SheetFooter", + label: "SheetFooter" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SheetHeader", + label: "SheetHeader" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SheetTitle", + label: "SheetTitle" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SheetTrigger", + label: "SheetTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Sidebar", + label: "Sidebar" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarContent", + label: "SidebarContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarFooter", + label: "SidebarFooter" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarGroup", + label: "SidebarGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarGroupAction", + label: "SidebarGroupAction" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarGroupContent", + label: "SidebarGroupContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarGroupLabel", + label: "SidebarGroupLabel" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarHeader", + label: "SidebarHeader" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarInput", + label: "SidebarInput" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarInset", + label: "SidebarInset" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarMenu", + label: "SidebarMenu" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarMenuAction", + label: "SidebarMenuAction" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarMenuBadge", + label: "SidebarMenuBadge" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarMenuButton", + label: "SidebarMenuButton" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarMenuItem", + label: "SidebarMenuItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarMenuSkeleton", + label: "SidebarMenuSkeleton" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarMenuSub", + label: "SidebarMenuSub" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarMenuSubButton", + label: "SidebarMenuSubButton" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarMenuSubItem", + label: "SidebarMenuSubItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarProvider", + label: "SidebarProvider" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarRail", + label: "SidebarRail" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarSeparator", + label: "SidebarSeparator" + }, + { + type: "doc", + id: "api/appkit-ui/functions/SidebarTrigger", + label: "SidebarTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Skeleton", + label: "Skeleton" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Slider", + label: "Slider" + }, + { + type: "doc", + id: "api/appkit-ui/functions/sortTimeSeriesAscending", + label: "sortTimeSeriesAscending" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Spinner", + label: "Spinner" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Switch", + label: "Switch" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Table", + label: "Table" + }, + { + type: "doc", + id: "api/appkit-ui/functions/TableBody", + label: "TableBody" + }, + { + type: "doc", + id: "api/appkit-ui/functions/TableCaption", + label: "TableCaption" + }, + { + type: "doc", + id: "api/appkit-ui/functions/TableCell", + label: "TableCell" + }, + { + type: "doc", + id: "api/appkit-ui/functions/TableFooter", + label: "TableFooter" + }, + { + type: "doc", + id: "api/appkit-ui/functions/TableHead", + label: "TableHead" + }, + { + type: "doc", + id: "api/appkit-ui/functions/TableHeader", + label: "TableHeader" + }, + { + type: "doc", + id: "api/appkit-ui/functions/TableRow", + label: "TableRow" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Tabs", + label: "Tabs" + }, + { + type: "doc", + id: "api/appkit-ui/functions/TabsContent", + label: "TabsContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/TabsList", + label: "TabsList" + }, + { + type: "doc", + id: "api/appkit-ui/functions/TabsTrigger", + label: "TabsTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Textarea", + label: "Textarea" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Toaster", + label: "Toaster" + }, + { + type: "doc", + id: "api/appkit-ui/functions/toChartArray", + label: "toChartArray" + }, + { + type: "doc", + id: "api/appkit-ui/functions/toChartValue", + label: "toChartValue" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Toggle", + label: "Toggle" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ToggleGroup", + label: "ToggleGroup" + }, + { + type: "doc", + id: "api/appkit-ui/functions/ToggleGroupItem", + label: "ToggleGroupItem" + }, + { + type: "doc", + id: "api/appkit-ui/functions/Tooltip", + label: "Tooltip" + }, + { + type: "doc", + id: "api/appkit-ui/functions/TooltipContent", + label: "TooltipContent" + }, + { + type: "doc", + id: "api/appkit-ui/functions/TooltipProvider", + label: "TooltipProvider" + }, + { + type: "doc", + id: "api/appkit-ui/functions/TooltipTrigger", + label: "TooltipTrigger" + }, + { + type: "doc", + id: "api/appkit-ui/functions/truncateLabel", + label: "truncateLabel" + }, + { + type: "doc", + id: "api/appkit-ui/functions/useAllThemeColors", + label: "useAllThemeColors" + }, + { + type: "doc", + id: "api/appkit-ui/functions/useAnalyticsQuery", + label: "useAnalyticsQuery" + }, + { + type: "doc", + id: "api/appkit-ui/functions/useChartData", + label: "useChartData" + }, + { + type: "doc", + id: "api/appkit-ui/functions/useFormField", + label: "useFormField" + }, + { + type: "doc", + id: "api/appkit-ui/functions/useSidebar", + label: "useSidebar" + }, + { + type: "doc", + id: "api/appkit-ui/functions/useThemeColors", + label: "useThemeColors" + } + ] + } + ] +}; +export default typedocSidebar; \ No newline at end of file diff --git a/docs/docs/api/appkit-ui/variables/AreaChart.md b/docs/docs/api/appkit-ui/variables/AreaChart.md new file mode 100644 index 0000000..7749bc4 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/AreaChart.md @@ -0,0 +1,48 @@ +# Variable: AreaChart + +```ts +const AreaChart: { +(props): Element; + displayName: string; +}; +``` + +Defined in: [packages/appkit-ui/src/react/charts/area/index.tsx:25](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/area/index.tsx#L25) + +Area Chart component. +Supports both JSON and Arrow data formats with automatic format selection. + +## Type Declaration + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`AreaChartProps`](../type-aliases/AreaChartProps.md) | + +## Returns + +`Element` + +### displayName + +```ts +displayName: string; +``` + +## Examples + +```tsx + +``` + +```tsx + +``` diff --git a/docs/docs/api/appkit-ui/variables/BarChart.md b/docs/docs/api/appkit-ui/variables/BarChart.md new file mode 100644 index 0000000..dcfde89 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/BarChart.md @@ -0,0 +1,57 @@ +# Variable: BarChart + +```ts +const BarChart: { +(props): Element; + displayName: string; +}; +``` + +Defined in: [packages/appkit-ui/src/react/charts/bar/index.tsx:35](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/bar/index.tsx#L35) + +Bar Chart component. +Supports both JSON and Arrow data formats with automatic format selection. + +## Type Declaration + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`BarChartProps`](../type-aliases/BarChartProps.md) | + +## Returns + +`Element` + +### displayName + +```ts +displayName: string; +``` + +## Examples + +```tsx + +``` + +```tsx + +``` + +```tsx + +``` diff --git a/docs/docs/api/appkit-ui/variables/CHART_COLOR_VARS.md b/docs/docs/api/appkit-ui/variables/CHART_COLOR_VARS.md new file mode 100644 index 0000000..7dd3d3b --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/CHART_COLOR_VARS.md @@ -0,0 +1,9 @@ +# Variable: CHART\_COLOR\_VARS + +```ts +const CHART_COLOR_VARS: readonly ["--chart-1", "--chart-2", "--chart-3", "--chart-4", "--chart-5", "--chart-6", "--chart-7", "--chart-8"]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/constants.ts:53](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/constants.ts#L53) + +Legacy: CSS variable names for chart colors (aliases to categorical) diff --git a/docs/docs/api/appkit-ui/variables/CHART_COLOR_VARS_CATEGORICAL.md b/docs/docs/api/appkit-ui/variables/CHART_COLOR_VARS_CATEGORICAL.md new file mode 100644 index 0000000..1b04329 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/CHART_COLOR_VARS_CATEGORICAL.md @@ -0,0 +1,9 @@ +# Variable: CHART\_COLOR\_VARS\_CATEGORICAL + +```ts +const CHART_COLOR_VARS_CATEGORICAL: readonly ["--chart-cat-1", "--chart-cat-2", "--chart-cat-3", "--chart-cat-4", "--chart-cat-5", "--chart-cat-6", "--chart-cat-7", "--chart-cat-8"]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/constants.ts:17](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/constants.ts#L17) + +CSS variable names for categorical chart colors (distinct categories) diff --git a/docs/docs/api/appkit-ui/variables/CHART_COLOR_VARS_DIVERGING.md b/docs/docs/api/appkit-ui/variables/CHART_COLOR_VARS_DIVERGING.md new file mode 100644 index 0000000..c5ea8e8 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/CHART_COLOR_VARS_DIVERGING.md @@ -0,0 +1,9 @@ +# Variable: CHART\_COLOR\_VARS\_DIVERGING + +```ts +const CHART_COLOR_VARS_DIVERGING: readonly ["--chart-div-1", "--chart-div-2", "--chart-div-3", "--chart-div-4", "--chart-div-5", "--chart-div-6", "--chart-div-7", "--chart-div-8"]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/constants.ts:41](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/constants.ts#L41) + +CSS variable names for diverging chart colors (negative ↔ positive) diff --git a/docs/docs/api/appkit-ui/variables/CHART_COLOR_VARS_SEQUENTIAL.md b/docs/docs/api/appkit-ui/variables/CHART_COLOR_VARS_SEQUENTIAL.md new file mode 100644 index 0000000..68633af --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/CHART_COLOR_VARS_SEQUENTIAL.md @@ -0,0 +1,9 @@ +# Variable: CHART\_COLOR\_VARS\_SEQUENTIAL + +```ts +const CHART_COLOR_VARS_SEQUENTIAL: readonly ["--chart-seq-1", "--chart-seq-2", "--chart-seq-3", "--chart-seq-4", "--chart-seq-5", "--chart-seq-6", "--chart-seq-7", "--chart-seq-8"]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/constants.ts:29](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/constants.ts#L29) + +CSS variable names for sequential chart colors (low → high) diff --git a/docs/docs/api/appkit-ui/variables/ChartLegend.md b/docs/docs/api/appkit-ui/variables/ChartLegend.md new file mode 100644 index 0000000..f71d78f --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/ChartLegend.md @@ -0,0 +1,7 @@ +# Variable: ChartLegend + +```ts +const ChartLegend: typeof Legend = RechartsPrimitive.Legend; +``` + +Defined in: [packages/appkit-ui/src/react/ui/chart.tsx:265](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/chart.tsx#L265) diff --git a/docs/docs/api/appkit-ui/variables/ChartTooltip.md b/docs/docs/api/appkit-ui/variables/ChartTooltip.md new file mode 100644 index 0000000..15d1708 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/ChartTooltip.md @@ -0,0 +1,7 @@ +# Variable: ChartTooltip + +```ts +const ChartTooltip: typeof Tooltip = RechartsPrimitive.Tooltip; +``` + +Defined in: [packages/appkit-ui/src/react/ui/chart.tsx:105](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/chart.tsx#L105) diff --git a/docs/docs/api/appkit-ui/variables/DATE_FIELD_PATTERNS.md b/docs/docs/api/appkit-ui/variables/DATE_FIELD_PATTERNS.md new file mode 100644 index 0000000..0bc9e69 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/DATE_FIELD_PATTERNS.md @@ -0,0 +1,9 @@ +# Variable: DATE\_FIELD\_PATTERNS + +```ts +const DATE_FIELD_PATTERNS: readonly ["date", "time", "period", "timestamp"]; +``` + +Defined in: [packages/appkit-ui/src/js/constants.ts:8](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/js/constants.ts#L8) + +Field patterns to detect date/time fields by name diff --git a/docs/docs/api/appkit-ui/variables/DonutChart.md b/docs/docs/api/appkit-ui/variables/DonutChart.md new file mode 100644 index 0000000..b791dbc --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/DonutChart.md @@ -0,0 +1,47 @@ +# Variable: DonutChart + +```ts +const DonutChart: { +(props): Element; + displayName: string; +}; +``` + +Defined in: [packages/appkit-ui/src/react/charts/pie/index.tsx:47](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/pie/index.tsx#L47) + +Donut Chart component (Pie chart with inner radius). +Supports both JSON and Arrow data formats with automatic format selection. + +## Type Declaration + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`DonutChartProps`](../type-aliases/DonutChartProps.md) | + +## Returns + +`Element` + +### displayName + +```ts +displayName: string; +``` + +## Examples + +```tsx + +``` + +```tsx + +``` diff --git a/docs/docs/api/appkit-ui/variables/FALLBACK_COLORS.md b/docs/docs/api/appkit-ui/variables/FALLBACK_COLORS.md new file mode 100644 index 0000000..47487c0 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/FALLBACK_COLORS.md @@ -0,0 +1,9 @@ +# Variable: FALLBACK\_COLORS + +```ts +const FALLBACK_COLORS: string[] = FALLBACK_COLORS_CATEGORICAL; +``` + +Defined in: [packages/appkit-ui/src/react/charts/constants.ts:105](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/constants.ts#L105) + +Legacy: Fallback colors (aliases to categorical) diff --git a/docs/docs/api/appkit-ui/variables/FALLBACK_COLORS_CATEGORICAL.md b/docs/docs/api/appkit-ui/variables/FALLBACK_COLORS_CATEGORICAL.md new file mode 100644 index 0000000..9b28642 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/FALLBACK_COLORS_CATEGORICAL.md @@ -0,0 +1,9 @@ +# Variable: FALLBACK\_COLORS\_CATEGORICAL + +```ts +const FALLBACK_COLORS_CATEGORICAL: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/constants.ts:69](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/constants.ts#L69) + +Fallback categorical colors diff --git a/docs/docs/api/appkit-ui/variables/FALLBACK_COLORS_DIVERGING.md b/docs/docs/api/appkit-ui/variables/FALLBACK_COLORS_DIVERGING.md new file mode 100644 index 0000000..5992ac6 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/FALLBACK_COLORS_DIVERGING.md @@ -0,0 +1,9 @@ +# Variable: FALLBACK\_COLORS\_DIVERGING + +```ts +const FALLBACK_COLORS_DIVERGING: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/constants.ts:93](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/constants.ts#L93) + +Fallback diverging colors (blue → red) diff --git a/docs/docs/api/appkit-ui/variables/FALLBACK_COLORS_SEQUENTIAL.md b/docs/docs/api/appkit-ui/variables/FALLBACK_COLORS_SEQUENTIAL.md new file mode 100644 index 0000000..755b1f1 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/FALLBACK_COLORS_SEQUENTIAL.md @@ -0,0 +1,9 @@ +# Variable: FALLBACK\_COLORS\_SEQUENTIAL + +```ts +const FALLBACK_COLORS_SEQUENTIAL: string[]; +``` + +Defined in: [packages/appkit-ui/src/react/charts/constants.ts:81](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/constants.ts#L81) + +Fallback sequential colors (light → dark blue) diff --git a/docs/docs/api/appkit-ui/variables/Form.md b/docs/docs/api/appkit-ui/variables/Form.md new file mode 100644 index 0000000..d98a6ce --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/Form.md @@ -0,0 +1,54 @@ +# Variable: Form() + +```ts +const Form: (props) => Element = FormProvider; +``` + +Defined in: [packages/appkit-ui/src/react/ui/form.tsx:19](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/form.tsx#L19) + +A provider component that propagates the `useForm` methods to all children components via [React Context](https://react.dev/reference/react/useContext) API. To be used with useFormContext. + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `TFieldValues` *extends* `FieldValues` | - | +| `TContext` | `any` | +| `TTransformedValues` | `TFieldValues` | + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `props` | `FormProviderProps`\<`TFieldValues`, `TContext`, `TTransformedValues`\> | all useForm methods | + +## Returns + +`Element` + +## Remarks + +[API](https://react-hook-form.com/docs/useformcontext) • [Demo](https://codesandbox.io/s/react-hook-form-v7-form-context-ytudi) + +## Example + +```tsx +function App() { + const methods = useForm(); + const onSubmit = data => console.log(data); + + return ( + +
+ + + +
+ ); +} + + function NestedInput() { + const { register } = useFormContext(); // retrieve all hook methods + return ; +} +``` diff --git a/docs/docs/api/appkit-ui/variables/HeatmapChart.md b/docs/docs/api/appkit-ui/variables/HeatmapChart.md new file mode 100644 index 0000000..5e63625 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/HeatmapChart.md @@ -0,0 +1,57 @@ +# Variable: HeatmapChart + +```ts +const HeatmapChart: { +(props): Element; + displayName: string; +}; +``` + +Defined in: [packages/appkit-ui/src/react/charts/heatmap/index.tsx:34](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/heatmap/index.tsx#L34) + +Heatmap Chart component. +Supports both JSON and Arrow data formats with automatic format selection. + +Data should be in "long format" with three fields: +- xKey: X-axis category (columns) +- yAxisKey: Y-axis category (rows) +- yKey: The numeric value for each cell + +## Type Declaration + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`HeatmapChartProps`](../type-aliases/HeatmapChartProps.md) | + +## Returns + +`Element` + +### displayName + +```ts +displayName: string; +``` + +## Examples + +```tsx + +``` + +```tsx + +``` diff --git a/docs/docs/api/appkit-ui/variables/LineChart.md b/docs/docs/api/appkit-ui/variables/LineChart.md new file mode 100644 index 0000000..2047531 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/LineChart.md @@ -0,0 +1,49 @@ +# Variable: LineChart + +```ts +const LineChart: { +(props): Element; + displayName: string; +}; +``` + +Defined in: [packages/appkit-ui/src/react/charts/line/index.tsx:26](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/line/index.tsx#L26) + +Line Chart component. +Supports both JSON and Arrow data formats with automatic format selection. + +## Type Declaration + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`LineChartProps`](../type-aliases/LineChartProps.md) | + +## Returns + +`Element` + +### displayName + +```ts +displayName: string; +``` + +## Examples + +```tsx + +``` + +```tsx + +``` diff --git a/docs/docs/api/appkit-ui/variables/METADATA_DATE_PATTERNS.md b/docs/docs/api/appkit-ui/variables/METADATA_DATE_PATTERNS.md new file mode 100644 index 0000000..abd078b --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/METADATA_DATE_PATTERNS.md @@ -0,0 +1,9 @@ +# Variable: METADATA\_DATE\_PATTERNS + +```ts +const METADATA_DATE_PATTERNS: readonly ["created", "updated", "modified", "deleted", "last_"]; +``` + +Defined in: [packages/appkit-ui/src/js/constants.ts:27](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/js/constants.ts#L27) + +Patterns that indicate a date field is metadata, not for charting diff --git a/docs/docs/api/appkit-ui/variables/NAME_FIELD_PATTERNS.md b/docs/docs/api/appkit-ui/variables/NAME_FIELD_PATTERNS.md new file mode 100644 index 0000000..90aad44 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/NAME_FIELD_PATTERNS.md @@ -0,0 +1,9 @@ +# Variable: NAME\_FIELD\_PATTERNS + +```ts +const NAME_FIELD_PATTERNS: readonly ["name", "label", "app", "user", "creator", "browser", "category"]; +``` + +Defined in: [packages/appkit-ui/src/js/constants.ts:16](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/js/constants.ts#L16) + +Field patterns to detect name/category fields by name diff --git a/docs/docs/api/appkit-ui/variables/PieChart.md b/docs/docs/api/appkit-ui/variables/PieChart.md new file mode 100644 index 0000000..cda5367 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/PieChart.md @@ -0,0 +1,48 @@ +# Variable: PieChart + +```ts +const PieChart: { +(props): Element; + displayName: string; +}; +``` + +Defined in: [packages/appkit-ui/src/react/charts/pie/index.tsx:25](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/pie/index.tsx#L25) + +Pie Chart component. +Supports both JSON and Arrow data formats with automatic format selection. + +## Type Declaration + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`PieChartProps`](../type-aliases/PieChartProps.md) | + +## Returns + +`Element` + +### displayName + +```ts +displayName: string; +``` + +## Examples + +```tsx + +``` + +```tsx + +``` diff --git a/docs/docs/api/appkit-ui/variables/RadarChart.md b/docs/docs/api/appkit-ui/variables/RadarChart.md new file mode 100644 index 0000000..7765c29 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/RadarChart.md @@ -0,0 +1,47 @@ +# Variable: RadarChart + +```ts +const RadarChart: { +(props): Element; + displayName: string; +}; +``` + +Defined in: [packages/appkit-ui/src/react/charts/radar/index.tsx:24](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/radar/index.tsx#L24) + +Radar Chart component. +Supports both JSON and Arrow data formats with automatic format selection. + +## Type Declaration + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`RadarChartProps`](../type-aliases/RadarChartProps.md) | + +## Returns + +`Element` + +### displayName + +```ts +displayName: string; +``` + +## Examples + +```tsx + +``` + +```tsx + +``` diff --git a/docs/docs/api/appkit-ui/variables/ScatterChart.md b/docs/docs/api/appkit-ui/variables/ScatterChart.md new file mode 100644 index 0000000..ab1a2d3 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/ScatterChart.md @@ -0,0 +1,47 @@ +# Variable: ScatterChart + +```ts +const ScatterChart: { +(props): Element; + displayName: string; +}; +``` + +Defined in: [packages/appkit-ui/src/react/charts/scatter/index.tsx:24](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/charts/scatter/index.tsx#L24) + +Scatter Chart component. +Supports both JSON and Arrow data formats with automatic format selection. + +## Type Declaration + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`ScatterChartProps`](../type-aliases/ScatterChartProps.md) | + +## Returns + +`Element` + +### displayName + +```ts +displayName: string; +``` + +## Examples + +```tsx + +``` + +```tsx + +``` diff --git a/docs/docs/api/appkit-ui/variables/badgeVariants.md b/docs/docs/api/appkit-ui/variables/badgeVariants.md new file mode 100644 index 0000000..909663e --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/badgeVariants.md @@ -0,0 +1,17 @@ +# Variable: badgeVariants() + +```ts +const badgeVariants: (props?) => string; +``` + +Defined in: [packages/appkit-ui/src/react/ui/badge.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/badge.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props?` | ConfigVariants\<\{ variant: \{ default: string; secondary: string; destructive: string; outline: string; \}; \}\> & ClassProp | + +## Returns + +`string` diff --git a/docs/docs/api/appkit-ui/variables/buttonGroupVariants.md b/docs/docs/api/appkit-ui/variables/buttonGroupVariants.md new file mode 100644 index 0000000..460f44d --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/buttonGroupVariants.md @@ -0,0 +1,17 @@ +# Variable: buttonGroupVariants() + +```ts +const buttonGroupVariants: (props?) => string; +``` + +Defined in: [packages/appkit-ui/src/react/ui/button-group.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/button-group.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props?` | ConfigVariants\<\{ orientation: \{ horizontal: string; vertical: string; \}; \}\> & ClassProp | + +## Returns + +`string` diff --git a/docs/docs/api/appkit-ui/variables/buttonVariants.md b/docs/docs/api/appkit-ui/variables/buttonVariants.md new file mode 100644 index 0000000..7458516 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/buttonVariants.md @@ -0,0 +1,17 @@ +# Variable: buttonVariants() + +```ts +const buttonVariants: (props?) => string; +``` + +Defined in: [packages/appkit-ui/src/react/ui/button.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/button.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props?` | ConfigVariants\<\{ variant: \{ default: string; destructive: string; outline: string; secondary: string; ghost: string; link: string; \}; size: \{ default: string; sm: string; lg: string; icon: string; "icon-sm": string; "icon-lg": string; \}; \}\> & ClassProp | + +## Returns + +`string` diff --git a/docs/docs/api/appkit-ui/variables/navigationMenuTriggerStyle.md b/docs/docs/api/appkit-ui/variables/navigationMenuTriggerStyle.md new file mode 100644 index 0000000..b1ef1a1 --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/navigationMenuTriggerStyle.md @@ -0,0 +1,17 @@ +# Variable: navigationMenuTriggerStyle() + +```ts +const navigationMenuTriggerStyle: (props?) => string; +``` + +Defined in: [packages/appkit-ui/src/react/ui/navigation-menu.tsx:61](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/navigation-menu.tsx#L61) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props?` | `ClassProp` | + +## Returns + +`string` diff --git a/docs/docs/api/appkit-ui/variables/toggleVariants.md b/docs/docs/api/appkit-ui/variables/toggleVariants.md new file mode 100644 index 0000000..943ddfe --- /dev/null +++ b/docs/docs/api/appkit-ui/variables/toggleVariants.md @@ -0,0 +1,17 @@ +# Variable: toggleVariants() + +```ts +const toggleVariants: (props?) => string; +``` + +Defined in: [packages/appkit-ui/src/react/ui/toggle.tsx:7](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/toggle.tsx#L7) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props?` | ConfigVariants\<\{ variant: \{ default: string; outline: string; \}; size: \{ default: string; sm: string; lg: string; \}; \}\> & ClassProp | + +## Returns + +`string` diff --git a/docs/docs/api/appkit/classes/CacheManager.md b/docs/docs/api/appkit/classes/CacheManager.md new file mode 100644 index 0000000..f4b5e08 --- /dev/null +++ b/docs/docs/api/appkit/classes/CacheManager.md @@ -0,0 +1,263 @@ +# Class: CacheManager + +Defined in: [appkit/src/cache/index.ts:24](https://github.com/databricks/appkit/blob/main/packages/appkit/src/cache/index.ts#L24) + +Cache manager class to handle cache operations. +Can be used with in-memory storage or persistent storage (Lakebase). + +The cache is automatically initialized by AppKit. Use `getInstanceSync()` to access +the singleton instance after initialization. + +## Example + +```typescript +const cache = CacheManager.getInstanceSync(); +const result = await cache.getOrExecute(["users", userId], () => fetchUser(userId), userKey); +``` + +## Methods + +### clear() + +```ts +clear(): Promise; +``` + +Defined in: [appkit/src/cache/index.ts:359](https://github.com/databricks/appkit/blob/main/packages/appkit/src/cache/index.ts#L359) + +Clear the cache + +#### Returns + +`Promise`\<`void`\> + +*** + +### close() + +```ts +close(): Promise; +``` + +Defined in: [appkit/src/cache/index.ts:395](https://github.com/databricks/appkit/blob/main/packages/appkit/src/cache/index.ts#L395) + +Close the cache + +#### Returns + +`Promise`\<`void`\> + +*** + +### delete() + +```ts +delete(key): Promise; +``` + +Defined in: [appkit/src/cache/index.ts:353](https://github.com/databricks/appkit/blob/main/packages/appkit/src/cache/index.ts#L353) + +Delete a value from the cache + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` | Cache key | + +#### Returns + +`Promise`\<`void`\> + +Promise of the result + +*** + +### generateKey() + +```ts +generateKey(parts, userKey): string; +``` + +Defined in: [appkit/src/cache/index.ts:388](https://github.com/databricks/appkit/blob/main/packages/appkit/src/cache/index.ts#L388) + +Generate a cache key + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `parts` | (`string` \| `number` \| `object`)[] | Parts of the key | +| `userKey` | `string` | User key | + +#### Returns + +`string` + +Cache key + +*** + +### get() + +```ts +get(key): Promise; +``` + +Defined in: [appkit/src/cache/index.ts:288](https://github.com/databricks/appkit/blob/main/packages/appkit/src/cache/index.ts#L288) + +Get a cached value + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` | Cache key | + +#### Returns + +`Promise`\<`T` \| `null`\> + +Promise of the value or null if not found or expired + +*** + +### getOrExecute() + +```ts +getOrExecute( + key, + fn, + userKey, +options?): Promise; +``` + +Defined in: [appkit/src/cache/index.ts:192](https://github.com/databricks/appkit/blob/main/packages/appkit/src/cache/index.ts#L192) + +Get or execute a function and cache the result + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | (`string` \| `number` \| `object`)[] | Cache key | +| `fn` | () => `Promise`\<`T`\> | Function to execute | +| `userKey` | `string` | User key | +| `options?` | \{ `ttl?`: `number`; \} | Options for the cache | +| `options.ttl?` | `number` | - | + +#### Returns + +`Promise`\<`T`\> + +Promise of the result + +*** + +### has() + +```ts +has(key): Promise; +``` + +Defined in: [appkit/src/cache/index.ts:369](https://github.com/databricks/appkit/blob/main/packages/appkit/src/cache/index.ts#L369) + +Check if a value exists in the cache + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` | Cache key | + +#### Returns + +`Promise`\<`boolean`\> + +Promise of true if the value exists, false otherwise + +*** + +### isStorageHealthy() + +```ts +isStorageHealthy(): Promise; +``` + +Defined in: [appkit/src/cache/index.ts:403](https://github.com/databricks/appkit/blob/main/packages/appkit/src/cache/index.ts#L403) + +Check if the storage is healthy + +#### Returns + +`Promise`\<`boolean`\> + +Promise of true if the storage is healthy, false otherwise + +*** + +### set() + +```ts +set( + key, + value, +options?): Promise; +``` + +Defined in: [appkit/src/cache/index.ts:336](https://github.com/databricks/appkit/blob/main/packages/appkit/src/cache/index.ts#L336) + +Set a value in the cache + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` | Cache key | +| `value` | `T` | Value to set | +| `options?` | \{ `ttl?`: `number`; \} | Options for the cache | +| `options.ttl?` | `number` | - | + +#### Returns + +`Promise`\<`void`\> + +Promise of the result + +*** + +### getInstanceSync() + +```ts +static getInstanceSync(): CacheManager; +``` + +Defined in: [appkit/src/cache/index.ts:72](https://github.com/databricks/appkit/blob/main/packages/appkit/src/cache/index.ts#L72) + +Get the singleton instance of the cache manager (sync version). + +Throws if not initialized - ensure AppKit.create() has completed first. + +#### Returns + +`CacheManager` + +CacheManager instance diff --git a/docs/docs/api/appkit/classes/Plugin.md b/docs/docs/api/appkit/classes/Plugin.md new file mode 100644 index 0000000..d04794f --- /dev/null +++ b/docs/docs/api/appkit/classes/Plugin.md @@ -0,0 +1,369 @@ +# Abstract Class: Plugin\ + +Defined in: [appkit/src/plugin/plugin.ts:33](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L33) + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `TConfig` *extends* [`BasePluginConfig`](../interfaces/BasePluginConfig.md) | [`BasePluginConfig`](../interfaces/BasePluginConfig.md) | + +## Implements + +- `BasePlugin` + +## Constructors + +### Constructor + +```ts +new Plugin(config): Plugin; +``` + +Defined in: [appkit/src/plugin/plugin.ts:54](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L54) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | `TConfig` | + +#### Returns + +`Plugin`\<`TConfig`\> + +## Properties + +### app + +```ts +protected app: AppManager; +``` + +Defined in: [appkit/src/plugin/plugin.ts:39](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L39) + +*** + +### cache + +```ts +protected cache: CacheManager; +``` + +Defined in: [appkit/src/plugin/plugin.ts:38](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L38) + +*** + +### config + +```ts +protected config: TConfig; +``` + +Defined in: [appkit/src/plugin/plugin.ts:54](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L54) + +*** + +### devFileReader + +```ts +protected devFileReader: DevFileReader; +``` + +Defined in: [appkit/src/plugin/plugin.ts:40](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L40) + +*** + +### envVars + +```ts +abstract protected envVars: string[]; +``` + +Defined in: [appkit/src/plugin/plugin.ts:43](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L43) + +*** + +### isReady + +```ts +protected isReady: boolean = false; +``` + +Defined in: [appkit/src/plugin/plugin.ts:37](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L37) + +*** + +### name + +```ts +name: string; +``` + +Defined in: [appkit/src/plugin/plugin.ts:52](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L52) + +#### Implementation of + +```ts +BasePlugin.name +``` + +*** + +### requiresDatabricksClient + +```ts +requiresDatabricksClient: boolean = false; +``` + +Defined in: [appkit/src/plugin/plugin.ts:46](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L46) + +If the plugin requires the Databricks client to be set in the request context + +*** + +### streamManager + +```ts +protected streamManager: StreamManager; +``` + +Defined in: [appkit/src/plugin/plugin.ts:41](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L41) + +*** + +### telemetry + +```ts +protected telemetry: ITelemetry; +``` + +Defined in: [appkit/src/plugin/plugin.ts:42](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L42) + +*** + +### phase + +```ts +static phase: PluginPhase = "normal"; +``` + +Defined in: [appkit/src/plugin/plugin.ts:51](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L51) + +## Methods + +### abortActiveOperations() + +```ts +abortActiveOperations(): void; +``` + +Defined in: [appkit/src/plugin/plugin.ts:79](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L79) + +#### Returns + +`void` + +#### Implementation of + +```ts +BasePlugin.abortActiveOperations +``` + +*** + +### execute() + +```ts +protected execute( + fn, + options, +userKey): Promise; +``` + +Defined in: [appkit/src/plugin/plugin.ts:143](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L143) + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fn` | (`signal?`) => `Promise`\<`T`\> | +| `options` | `PluginExecutionSettings` | +| `userKey` | `string` | + +#### Returns + +`Promise`\<`T` \| `undefined`\> + +*** + +### executeStream() + +```ts +protected executeStream( + res, + fn, + options, +userKey): Promise; +``` + +Defined in: [appkit/src/plugin/plugin.ts:84](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L84) + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `res` | `IAppResponse` | +| `fn` | `StreamExecuteHandler`\<`T`\> | +| `options` | [`StreamExecutionSettings`](../interfaces/StreamExecutionSettings.md) | +| `userKey` | `string` | + +#### Returns + +`Promise`\<`void`\> + +*** + +### getEndpoints() + +```ts +getEndpoints(): PluginEndpointMap; +``` + +Defined in: [appkit/src/plugin/plugin.ts:75](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L75) + +#### Returns + +`PluginEndpointMap` + +#### Implementation of + +```ts +BasePlugin.getEndpoints +``` + +*** + +### injectRoutes() + +```ts +injectRoutes(_): void; +``` + +Defined in: [appkit/src/plugin/plugin.ts:69](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L69) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `_` | `Router` | + +#### Returns + +`void` + +#### Implementation of + +```ts +BasePlugin.injectRoutes +``` + +*** + +### registerEndpoint() + +```ts +protected registerEndpoint(name, path): void; +``` + +Defined in: [appkit/src/plugin/plugin.ts:165](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L165) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `path` | `string` | + +#### Returns + +`void` + +*** + +### route() + +```ts +protected route<_TResponse>(router, config): void; +``` + +Defined in: [appkit/src/plugin/plugin.ts:169](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L169) + +#### Type Parameters + +| Type Parameter | +| ------ | +| `_TResponse` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `router` | `Router` | +| `config` | `RouteConfig` | + +#### Returns + +`void` + +*** + +### setup() + +```ts +setup(): Promise; +``` + +Defined in: [appkit/src/plugin/plugin.ts:73](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L73) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +```ts +BasePlugin.setup +``` + +*** + +### validateEnv() + +```ts +validateEnv(): void; +``` + +Defined in: [appkit/src/plugin/plugin.ts:65](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/plugin.ts#L65) + +#### Returns + +`void` + +#### Implementation of + +```ts +BasePlugin.validateEnv +``` diff --git a/docs/docs/api/appkit/functions/appKitTypesPlugin.md b/docs/docs/api/appkit/functions/appKitTypesPlugin.md new file mode 100644 index 0000000..53b7a06 --- /dev/null +++ b/docs/docs/api/appkit/functions/appKitTypesPlugin.md @@ -0,0 +1,22 @@ +# Function: appKitTypesPlugin() + +```ts +function appKitTypesPlugin(options?): Plugin$1; +``` + +Defined in: [appkit/src/type-generator/vite-plugin.ts:21](https://github.com/databricks/appkit/blob/main/packages/appkit/src/type-generator/vite-plugin.ts#L21) + +Vite plugin to generate types for AppKit queries. +Calls `npx appkit-generate-types` under the hood. + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `options?` | `AppKitTypesPluginOptions` | Options to override default values. | + +## Returns + +`Plugin$1` + +Vite plugin to generate types for AppKit queries. diff --git a/docs/docs/api/appkit/functions/createApp.md b/docs/docs/api/appkit/functions/createApp.md new file mode 100644 index 0000000..ba6569c --- /dev/null +++ b/docs/docs/api/appkit/functions/createApp.md @@ -0,0 +1,26 @@ +# Function: createApp() + +```ts +function createApp(config): Promise>; +``` + +Defined in: [appkit/src/core/appkit.ts:124](https://github.com/databricks/appkit/blob/main/packages/appkit/src/core/appkit.ts#L124) + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `PluginData`\<`PluginConstructor`, `unknown`, `string`\>[] | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | \{ `cache?`: `CacheConfig`; `plugins?`: `T`; `telemetry?`: `TelemetryConfig`; \} | +| `config.cache?` | `CacheConfig` | +| `config.plugins?` | `T` | +| `config.telemetry?` | `TelemetryConfig` | + +## Returns + +`Promise`\<`PluginMap`\<`T`\>\> diff --git a/docs/docs/api/appkit/functions/getRequestContext.md b/docs/docs/api/appkit/functions/getRequestContext.md new file mode 100644 index 0000000..3b9019a --- /dev/null +++ b/docs/docs/api/appkit/functions/getRequestContext.md @@ -0,0 +1,11 @@ +# Function: getRequestContext() + +```ts +function getRequestContext(): RequestContext; +``` + +Defined in: [appkit/src/utils/databricks-client-middleware.ts:96](https://github.com/databricks/appkit/blob/main/packages/appkit/src/utils/databricks-client-middleware.ts#L96) + +## Returns + +`RequestContext` diff --git a/docs/docs/api/appkit/functions/isSQLTypeMarker.md b/docs/docs/api/appkit/functions/isSQLTypeMarker.md new file mode 100644 index 0000000..c82d0b0 --- /dev/null +++ b/docs/docs/api/appkit/functions/isSQLTypeMarker.md @@ -0,0 +1,32 @@ +# Function: isSQLTypeMarker() + +```ts +function isSQLTypeMarker(value): 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 + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `value` | `any` | Value to check | + +## Returns + +`value is SQLTypeMarker` + +True if the value is a SQL type marker, false otherwise + +## Example + +```typescript +const value = { + __sql_type: "DATE", + value: "2024-01-01", +}; +const isSQLTypeMarker = isSQLTypeMarker(value); +console.log(isSQLTypeMarker); // true +``` diff --git a/docs/docs/api/appkit/functions/toPlugin.md b/docs/docs/api/appkit/functions/toPlugin.md new file mode 100644 index 0000000..43718f5 --- /dev/null +++ b/docs/docs/api/appkit/functions/toPlugin.md @@ -0,0 +1,26 @@ +# Function: toPlugin() + +```ts +function toPlugin(plugin, name): ToPlugin; +``` + +Defined in: [appkit/src/plugin/to-plugin.ts:3](https://github.com/databricks/appkit/blob/main/packages/appkit/src/plugin/to-plugin.ts#L3) + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | +| `U` | +| `N` *extends* `string` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `plugin` | `T` | +| `name` | `N` | + +## Returns + +`ToPlugin`\<`T`, `U`, `N`\> diff --git a/docs/docs/api/appkit/index.md b/docs/docs/api/appkit/index.md new file mode 100644 index 0000000..74e2d5b --- /dev/null +++ b/docs/docs/api/appkit/index.md @@ -0,0 +1,41 @@ +# @databricks/appkit + +## Classes + +| Class | Description | +| ------ | ------ | +| [CacheManager](classes/CacheManager.md) | Cache manager class to handle cache operations. Can be used with in-memory storage or persistent storage (Lakebase). | +| [Plugin](classes/Plugin.md) | - | + +## Interfaces + +| Interface | Description | +| ------ | ------ | +| [BasePluginConfig](interfaces/BasePluginConfig.md) | - | +| [ITelemetry](interfaces/ITelemetry.md) | Plugin-facing interface for OpenTelemetry instrumentation. Provides a thin abstraction over OpenTelemetry APIs for plugins. | +| [StreamExecutionSettings](interfaces/StreamExecutionSettings.md) | - | + +## Type Aliases + +| Type Alias | Description | +| ------ | ------ | +| [IAppRouter](type-aliases/IAppRouter.md) | - | +| [SQLTypeMarker](type-aliases/SQLTypeMarker.md) | Object that identifies a typed SQL parameter. Created using sql.date(), sql.string(), sql.number(), sql.boolean(), sql.timestamp(), sql.binary(), or sql.interval(). | + +## Variables + +| Variable | Description | +| ------ | ------ | +| [analytics](variables/analytics.md) | - | +| [server](variables/server.md) | - | +| [sql](variables/sql.md) | SQL helper namespace | + +## Functions + +| Function | Description | +| ------ | ------ | +| [appKitTypesPlugin](functions/appKitTypesPlugin.md) | Vite plugin to generate types for AppKit queries. Calls `npx appkit-generate-types` under the hood. | +| [createApp](functions/createApp.md) | - | +| [getRequestContext](functions/getRequestContext.md) | - | +| [isSQLTypeMarker](functions/isSQLTypeMarker.md) | Type guard to check if a value is a SQL type marker | +| [toPlugin](functions/toPlugin.md) | - | diff --git a/docs/docs/api/appkit/interfaces/BasePluginConfig.md b/docs/docs/api/appkit/interfaces/BasePluginConfig.md new file mode 100644 index 0000000..d47a75c --- /dev/null +++ b/docs/docs/api/appkit/interfaces/BasePluginConfig.md @@ -0,0 +1,39 @@ +# Interface: BasePluginConfig + +Defined in: [shared/src/plugin.ts:17](https://github.com/databricks/appkit/blob/main/packages/shared/src/plugin.ts#L17) + +## Indexable + +```ts +[key: string]: unknown +``` + +## Properties + +### host? + +```ts +optional host: string; +``` + +Defined in: [shared/src/plugin.ts:19](https://github.com/databricks/appkit/blob/main/packages/shared/src/plugin.ts#L19) + +*** + +### name? + +```ts +optional name: string; +``` + +Defined in: [shared/src/plugin.ts:18](https://github.com/databricks/appkit/blob/main/packages/shared/src/plugin.ts#L18) + +*** + +### telemetry? + +```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/interfaces/ITelemetry.md b/docs/docs/api/appkit/interfaces/ITelemetry.md new file mode 100644 index 0000000..dadcf93 --- /dev/null +++ b/docs/docs/api/appkit/interfaces/ITelemetry.md @@ -0,0 +1,157 @@ +# 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. + +## Methods + +### emit() + +```ts +emit(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. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `logRecord` | `LogRecord` | The log record to emit | + +#### Returns + +`void` + +*** + +### getLogger() + +```ts +getLogger(options?): 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 + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `options?` | `InstrumentConfig` | Instrument customization options. | + +#### Returns + +`Logger` + +*** + +### getMeter() + +```ts +getMeter(options?): 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 + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `options?` | `InstrumentConfig` | Instrument customization options. | + +#### Returns + +`Meter` + +*** + +### getTracer() + +```ts +getTracer(options?): 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 + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `options?` | `InstrumentConfig` | Instrument customization options. | + +#### Returns + +`Tracer` + +*** + +### registerInstrumentations() + +```ts +registerInstrumentations(instrumentations): 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. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `instrumentations` | `Instrumentation`\<`InstrumentationConfig`\>[] | Array of OpenTelemetry instrumentations to register | + +#### Returns + +`void` + +*** + +### startActiveSpan() + +```ts +startActiveSpan( + name, + options, + fn, +tracerOptions?): 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. + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `name` | `string` | The name of the span | +| `options` | `SpanOptions` | Span options including attributes, kind, etc. | +| `fn` | (`span`) => `Promise`\<`T`\> | Callback function to execute within the span context | +| `tracerOptions?` | `InstrumentConfig` | Optional tracer configuration (custom name, prefix inclusion) | + +#### Returns + +`Promise`\<`T`\> + +Promise resolving to the callback's return value diff --git a/docs/docs/api/appkit/interfaces/StreamExecutionSettings.md b/docs/docs/api/appkit/interfaces/StreamExecutionSettings.md new file mode 100644 index 0000000..34d3569 --- /dev/null +++ b/docs/docs/api/appkit/interfaces/StreamExecutionSettings.md @@ -0,0 +1,33 @@ +# Interface: StreamExecutionSettings + +Defined in: [shared/src/execute.ts:48](https://github.com/databricks/appkit/blob/main/packages/shared/src/execute.ts#L48) + +## Properties + +### default + +```ts +default: PluginExecuteConfig; +``` + +Defined in: [shared/src/execute.ts:49](https://github.com/databricks/appkit/blob/main/packages/shared/src/execute.ts#L49) + +*** + +### stream? + +```ts +optional stream: StreamConfig; +``` + +Defined in: [shared/src/execute.ts:51](https://github.com/databricks/appkit/blob/main/packages/shared/src/execute.ts#L51) + +*** + +### user? + +```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/type-aliases/IAppRouter.md b/docs/docs/api/appkit/type-aliases/IAppRouter.md new file mode 100644 index 0000000..08197ba --- /dev/null +++ b/docs/docs/api/appkit/type-aliases/IAppRouter.md @@ -0,0 +1,7 @@ +# Type Alias: IAppRouter + +```ts +type IAppRouter = express.Router; +``` + +Defined in: [shared/src/plugin.ts:94](https://github.com/databricks/appkit/blob/main/packages/shared/src/plugin.ts#L94) diff --git a/docs/docs/api/appkit/type-aliases/SQLTypeMarker.md b/docs/docs/api/appkit/type-aliases/SQLTypeMarker.md new file mode 100644 index 0000000..3c049b2 --- /dev/null +++ b/docs/docs/api/appkit/type-aliases/SQLTypeMarker.md @@ -0,0 +1,16 @@ +# Type Alias: SQLTypeMarker + +```ts +type SQLTypeMarker = + | SQLStringMarker + | SQLNumberMarker + | SQLBooleanMarker + | SQLBinaryMarker + | SQLDateMarker + | SQLTimestampMarker; +``` + +Defined in: [shared/src/sql/types.ts:36](https://github.com/databricks/appkit/blob/main/packages/shared/src/sql/types.ts#L36) + +Object that identifies a typed SQL parameter. +Created using sql.date(), sql.string(), sql.number(), sql.boolean(), sql.timestamp(), sql.binary(), or sql.interval(). diff --git a/docs/docs/api/appkit/typedoc-sidebar.ts b/docs/docs/api/appkit/typedoc-sidebar.ts new file mode 100644 index 0000000..50ae28f --- /dev/null +++ b/docs/docs/api/appkit/typedoc-sidebar.ts @@ -0,0 +1,111 @@ +import { SidebarsConfig } from "@docusaurus/plugin-content-docs"; +const typedocSidebar: SidebarsConfig = { + items: [ + { + type: "category", + label: "Classes", + items: [ + { + type: "doc", + id: "api/appkit/classes/CacheManager", + label: "CacheManager" + }, + { + type: "doc", + id: "api/appkit/classes/Plugin", + label: "Plugin" + } + ] + }, + { + type: "category", + label: "Interfaces", + items: [ + { + type: "doc", + id: "api/appkit/interfaces/BasePluginConfig", + label: "BasePluginConfig" + }, + { + type: "doc", + id: "api/appkit/interfaces/ITelemetry", + label: "ITelemetry" + }, + { + type: "doc", + id: "api/appkit/interfaces/StreamExecutionSettings", + label: "StreamExecutionSettings" + } + ] + }, + { + type: "category", + label: "Type Aliases", + items: [ + { + type: "doc", + id: "api/appkit/type-aliases/IAppRouter", + label: "IAppRouter" + }, + { + type: "doc", + id: "api/appkit/type-aliases/SQLTypeMarker", + label: "SQLTypeMarker" + } + ] + }, + { + type: "category", + label: "Variables", + items: [ + { + type: "doc", + id: "api/appkit/variables/analytics", + label: "analytics" + }, + { + type: "doc", + id: "api/appkit/variables/server", + label: "server" + }, + { + type: "doc", + id: "api/appkit/variables/sql", + label: "sql" + } + ] + }, + { + type: "category", + label: "Functions", + items: [ + { + type: "doc", + id: "api/appkit/functions/appKitTypesPlugin", + label: "appKitTypesPlugin" + }, + { + type: "doc", + id: "api/appkit/functions/createApp", + label: "createApp" + }, + { + type: "doc", + id: "api/appkit/functions/getRequestContext", + label: "getRequestContext" + }, + { + type: "doc", + id: "api/appkit/functions/isSQLTypeMarker", + label: "isSQLTypeMarker" + }, + { + type: "doc", + id: "api/appkit/functions/toPlugin", + label: "toPlugin" + } + ] + } + ] +}; +export default typedocSidebar; \ No newline at end of file diff --git a/docs/docs/api/appkit/variables/analytics.md b/docs/docs/api/appkit/variables/analytics.md new file mode 100644 index 0000000..400b8f4 --- /dev/null +++ b/docs/docs/api/appkit/variables/analytics.md @@ -0,0 +1,7 @@ +# Variable: analytics + +```ts +const analytics: ToPlugin; +``` + +Defined in: [appkit/src/analytics/analytics.ts:243](https://github.com/databricks/appkit/blob/main/packages/appkit/src/analytics/analytics.ts#L243) diff --git a/docs/docs/api/appkit/variables/server.md b/docs/docs/api/appkit/variables/server.md new file mode 100644 index 0000000..efb38de --- /dev/null +++ b/docs/docs/api/appkit/variables/server.md @@ -0,0 +1,7 @@ +# Variable: server + +```ts +const server: ToPlugin; +``` + +Defined in: [appkit/src/server/index.ts:332](https://github.com/databricks/appkit/blob/main/packages/appkit/src/server/index.ts#L332) diff --git a/docs/docs/api/appkit/variables/sql.md b/docs/docs/api/appkit/variables/sql.md new file mode 100644 index 0000000..c6a2f8c --- /dev/null +++ b/docs/docs/api/appkit/variables/sql.md @@ -0,0 +1,239 @@ +# Variable: sql + +```ts +const sql: object; +``` + +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 + +### binary() + +```ts +binary(value): SQLBinaryMarker; +``` + +Creates a BINARY parameter as hex-encoded STRING +Accepts Uint8Array, ArrayBuffer, or hex string +Note: Databricks SQL Warehouse doesn't support BINARY as parameter type, +so this helper returns a STRING with hex encoding. Use UNHEX(:param) in your SQL. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `value` | `string` \| `Uint8Array` \| `ArrayBuffer` | Uint8Array, ArrayBuffer, or hex string | + +#### Returns + +`SQLBinaryMarker` + +Marker object with STRING type and hex-encoded value + +#### Examples + +```typescript +// From Uint8Array: +const params = { data: sql.binary(new Uint8Array([0x53, 0x70, 0x61, 0x72, 0x6b])) }; +// Returns: { __sql_type: "STRING", value: "537061726B" } +// SQL: SELECT UNHEX(:data) as binary_value +``` + +```typescript +// From hex string: +const params = { data: sql.binary("537061726B") }; +// Returns: { __sql_type: "STRING", value: "537061726B" } +``` + +### boolean() + +```ts +boolean(value): SQLBooleanMarker; +``` + +Create a BOOLEAN type parameter +Accepts booleans, strings, or numbers + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `value` | `string` \| `number` \| `boolean` | Boolean, string, or number | + +#### Returns + +`SQLBooleanMarker` + +Marker object for BOOLEAN type parameter + +#### Examples + +```typescript +const params = { isActive: sql.boolean(true) }; +params = { isActive: "true" } +``` + +```typescript +const params = { isActive: sql.boolean("true") }; +params = { isActive: "true" } +``` + +```typescript +const params = { isActive: sql.boolean(1) }; +params = { isActive: "true" } +``` + +```typescript +const params = { isActive: sql.boolean("false") }; +params = { isActive: "false" } +``` + +```typescript +const params = { isActive: sql.boolean(0) }; +params = { isActive: "false" } +``` + +### date() + +```ts +date(value): SQLDateMarker; +``` + +Creates a DATE type parameter +Accepts Date objects or ISO date strings (YYYY-MM-DD format) + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `value` | `string` \| `Date` | Date object or ISO date string | + +#### Returns + +`SQLDateMarker` + +Marker object for DATE type parameter + +#### Examples + +```typescript +const params = { startDate: sql.date(new Date("2024-01-01")) }; +params = { startDate: "2024-01-01" } +``` + +```typescript +const params = { startDate: sql.date("2024-01-01") }; +params = { startDate: "2024-01-01" } +``` + +### number() + +```ts +number(value): SQLNumberMarker; +``` + +Creates a NUMERIC type parameter +Accepts numbers or numeric strings + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `value` | `string` \| `number` | Number or numeric string | + +#### Returns + +`SQLNumberMarker` + +Marker object for NUMERIC type parameter + +#### Examples + +```typescript +const params = { userId: sql.number(123) }; +params = { userId: "123" } +``` + +```typescript +const params = { userId: sql.number("123") }; +params = { userId: "123" } +``` + +### string() + +```ts +string(value): SQLStringMarker; +``` + +Creates a STRING type parameter +Accepts strings, numbers, or booleans + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `value` | `string` \| `number` \| `boolean` | String, number, or boolean | + +#### Returns + +`SQLStringMarker` + +Marker object for STRING type parameter + +#### Examples + +```typescript +const params = { name: sql.string("John") }; +params = { name: "John" } +``` + +```typescript +const params = { name: sql.string(123) }; +params = { name: "123" } +``` + +```typescript +const params = { name: sql.string(true) }; +params = { name: "true" } +``` + +### timestamp() + +```ts +timestamp(value): SQLTimestampMarker; +``` + +Creates a TIMESTAMP type parameter +Accepts Date objects, ISO timestamp strings, or Unix timestamp numbers + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `value` | `string` \| `number` \| `Date` | Date object, ISO timestamp string, or Unix timestamp number | + +#### Returns + +`SQLTimestampMarker` + +Marker object for TIMESTAMP type parameter + +#### Examples + +```typescript +const params = { createdTime: sql.timestamp(new Date("2024-01-01T12:00:00Z")) }; +params = { createdTime: "2024-01-01T12:00:00Z" } +``` + +```typescript +const params = { createdTime: sql.timestamp("2024-01-01T12:00:00Z") }; +params = { createdTime: "2024-01-01T12:00:00Z" } +``` + +```typescript +const params = { createdTime: sql.timestamp(1704110400000) }; +params = { createdTime: "2024-01-01T12:00:00Z" } +``` diff --git a/docs/docs/api/index.md b/docs/docs/api/index.md new file mode 100644 index 0000000..08d64d8 --- /dev/null +++ b/docs/docs/api/index.md @@ -0,0 +1,8 @@ +# API Reference + +This section contains the API reference for the AppKit packages. + +## Modules + +- [`appkit`](appkit/index.md) - Core library +- [`appkit-ui`](appkit-ui/index.md) - UI components library diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 37d33b6..feaf983 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -63,7 +63,55 @@ const config: Config = { ], ], - plugins: [require.resolve("docusaurus-lunr-search")], + plugins: [ + require.resolve("docusaurus-lunr-search"), + [ + "docusaurus-plugin-typedoc", + { + id: "appkit", + entryPoints: ["../packages/appkit/src/index.ts"], + tsconfig: "../packages/appkit/tsconfig.json", + out: "docs/api/appkit", + gitRevision: "main", + useCodeBlocks: true, + excludeExternals: true, + excludePrivate: true, + excludeProtected: false, + excludeInternal: true, + indexFormat: "table", + readme: "none", + parametersFormat: "table", + sidebar: { + autoConfiguration: true, + pretty: true, + typescript: true, + }, + }, + ], + [ + "docusaurus-plugin-typedoc", + { + id: "appkit-ui", + entryPoints: ["../packages/appkit-ui/src/react/index.ts"], + tsconfig: "../packages/appkit-ui/tsconfig.json", + out: "docs/api/appkit-ui", + gitRevision: "main", + useCodeBlocks: true, + excludeExternals: true, + excludePrivate: true, + excludeProtected: false, + excludeInternal: true, + indexFormat: "table", + readme: "none", + parametersFormat: "table", + sidebar: { + autoConfiguration: true, + pretty: true, + typescript: true, + }, + }, + ], + ], themeConfig: { colorMode: { @@ -116,6 +164,10 @@ const config: Config = { label: "Getting started", to: "/docs/", }, + { + label: "API Reference", + to: "/docs/api/", + }, ], }, { diff --git a/docs/package.json b/docs/package.json index 24f8652..05f2fc6 100644 --- a/docs/package.json +++ b/docs/package.json @@ -29,6 +29,9 @@ "@docusaurus/module-type-aliases": "3.9.2", "@docusaurus/tsconfig": "3.9.2", "@docusaurus/types": "3.9.2", + "docusaurus-plugin-typedoc": "^1.4.2", + "typedoc": "^0.28.15", + "typedoc-plugin-markdown": "^4.9.0", "typescript": "~5.6.2" }, "browserslist": { diff --git a/docs/sidebars.ts b/docs/sidebars.ts index da11c4b..3268cfb 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -1,4 +1,6 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; +import typedocSidebar from "./docs/api/appkit/typedoc-sidebar"; +import uiTypedocSidebar from "./docs/api/appkit-ui/typedoc-sidebar"; // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) @@ -13,21 +15,40 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; Create as many sidebars as you want. */ const sidebars: SidebarsConfig = { - // By default, Docusaurus generates a sidebar from the docs folder structure - docsSidebar: [{ type: "autogenerated", dirName: "." }], - - // But you can create a sidebar manually - /* - tutorialSidebar: [ - 'intro', - 'hello', + docsSidebar: [ + { + type: "autogenerated", + dirName: ".", + }, { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], + type: "category", + label: "API Reference", + link: { + type: "doc", + id: "api/index", + }, + items: [ + { + type: "category", + label: "@databricks/appkit", + link: { + type: "doc", + id: "api/appkit/index", + }, + items: typedocSidebar.items, + }, + { + type: "category", + label: "@databricks/appkit-ui", + link: { + type: "doc", + id: "api/appkit-ui/index", + }, + items: uiTypedocSidebar.items, + }, + ], }, ], - */ }; export default sidebars; diff --git a/packages/appkit-ui/src/react/charts/normalize.ts b/packages/appkit-ui/src/react/charts/normalize.ts index abf674e..63a6aca 100644 --- a/packages/appkit-ui/src/react/charts/normalize.ts +++ b/packages/appkit-ui/src/react/charts/normalize.ts @@ -316,7 +316,7 @@ export interface NormalizedHeatmapData extends NormalizedChartDataBase { /** * Normalizes data specifically for heatmap charts. - * Expects data in format: { xKey: string, yAxisKey: string, valueKey: number } + * Expects data in format: `{ xKey: string, yAxisKey: string, valueKey: number }` * * @param data - Raw data (Arrow Table or JSON array) * @param xKey - Field key for X-axis (columns) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 7ad51da..aff88f0 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -185,6 +185,15 @@ importers: '@docusaurus/types': specifier: 3.9.2 version: 3.9.2(react-dom@19.2.0(react@19.2.0))(react@19.2.0) + docusaurus-plugin-typedoc: + specifier: ^1.4.2 + version: 1.4.2(typedoc-plugin-markdown@4.9.0(typedoc@0.28.15(typescript@5.6.3))) + typedoc: + specifier: ^0.28.15 + version: 0.28.15(typescript@5.6.3) + typedoc-plugin-markdown: + specifier: ^4.9.0 + version: 4.9.0(typedoc@0.28.15(typescript@5.6.3)) typescript: specifier: ~5.6.2 version: 5.6.3 @@ -2030,6 +2039,9 @@ packages: '@floating-ui/utils@0.2.10': resolution: {integrity: sha512-aGTxbpbg8/b5JfU1HXSrbH3wXZuLPJcNEcZQFMxLs3oSzgtVu6nFPkbbGGUvBcUjKV2YyB9Wxxabo+HEH9tcRQ==} + '@gerrit0/mini-shiki@3.20.0': + resolution: {integrity: sha512-Wa57i+bMpK6PGJZ1f2myxo3iO+K/kZikcyvH8NIqNNZhQUbDav7V9LQmWOXhf946mz5c1NZ19WMsGYiDKTryzQ==} + '@grpc/grpc-js@1.14.1': resolution: {integrity: sha512-sPxgEWtPUR3EnRJCEtbGZG2iX8LQDUls2wUS3o27jg07KqJFMq6YDeWvMo1wfpmy3rqRdS0rivpLwhqQtEyCuQ==} engines: {node: '>=12.10.0'} @@ -3629,6 +3641,21 @@ packages: cpu: [x64] os: [win32] + '@shikijs/engine-oniguruma@3.20.0': + resolution: {integrity: sha512-Yx3gy7xLzM0ZOjqoxciHjA7dAt5tyzJE3L4uQoM83agahy+PlW244XJSrmJRSBvGYELDhYXPacD4R/cauV5bzQ==} + + '@shikijs/langs@3.20.0': + resolution: {integrity: sha512-le+bssCxcSHrygCWuOrYJHvjus6zhQ2K7q/0mgjiffRbkhM4o1EWu2m+29l0yEsHDbWaWPNnDUTRVVBvBBeKaA==} + + '@shikijs/themes@3.20.0': + resolution: {integrity: sha512-U1NSU7Sl26Q7ErRvJUouArxfM2euWqq1xaSrbqMu2iqa+tSp0D1Yah8216sDYbdDHw4C8b75UpE65eWorm2erQ==} + + '@shikijs/types@3.20.0': + resolution: {integrity: sha512-lhYAATn10nkZcBQ0BlzSbJA3wcmL5MXUUF8d2Zzon6saZDlToKaiRX60n2+ZaHJCmXEcZRWNzn+k9vplr8Jhsw==} + + '@shikijs/vscode-textmate@10.0.2': + resolution: {integrity: sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==} + '@sideway/address@4.1.5': resolution: {integrity: sha512-IqO/DUQHUkPeixNQ8n0JA6102hT9CmaljNTPmQ1u8MEhBo/R4Q8eKLN/vGZxuebwOroDB4cbpjheD4+/sKFK4Q==} @@ -5353,6 +5380,11 @@ packages: react: ^16.8.4 || ^17 || ^18 || ^19 react-dom: ^16.8.4 || ^17 || ^18 || ^19 + docusaurus-plugin-typedoc@1.4.2: + resolution: {integrity: sha512-1qerRejLSYxEWdyVPLDMMeKFPLA/37yZAsdwJy9ThHFQR78+v3b5spSbk67VHGLr2mAn4FVHu0aGJ6p7iWotSg==} + peerDependencies: + typedoc-plugin-markdown: '>=4.8.0' + dom-accessibility-api@0.5.16: resolution: {integrity: sha512-X7BJ2yElsnOJ30pZF4uIIDfBEVgF4XEBxL9Bxhy6dnrm5hkzqmsWHGTiHqRiITNhMyFLyAiWndIJP7Z1NTteDg==} @@ -6839,6 +6871,9 @@ packages: lines-and-columns@1.2.4: resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==} + linkify-it@5.0.0: + resolution: {integrity: sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==} + lint-staged@15.5.2: resolution: {integrity: sha512-YUSOLq9VeRNAo/CTaVmhGDKG+LBtA8KF1X4K5+ykMSwWST1vDxJRB2kv2COgLb1fvpCo+A/y9A0G0znNVmdx4w==} engines: {node: '>=18.12.0'} @@ -6977,6 +7012,10 @@ packages: resolution: {integrity: sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q==} engines: {node: '>=16'} + markdown-it@14.1.0: + resolution: {integrity: sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==} + hasBin: true + markdown-table@2.0.0: resolution: {integrity: sha512-Ezda85ToJUBhM6WGaG6veasyym+Tbs3cMAw/ZhOPqXiYsr0jgocBV3j3nx+4lk47plLlIqjwuTm/ywVI+zjJ/A==} @@ -7055,6 +7094,9 @@ packages: mdn-data@2.12.2: resolution: {integrity: sha512-IEn+pegP1aManZuckezWCO+XZQDplx1366JoVhTpMpBB1sPey/SbveZQUosKiKiGYjg1wH4pMlNgXbCiYgihQA==} + mdurl@2.0.0: + resolution: {integrity: sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==} + media-typer@0.3.0: resolution: {integrity: sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==} engines: {node: '>= 0.6'} @@ -8177,6 +8219,10 @@ packages: engines: {node: '>=18'} hasBin: true + punycode.js@2.3.1: + resolution: {integrity: sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==} + engines: {node: '>=6'} + punycode@2.3.1: resolution: {integrity: sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==} engines: {node: '>=6'} @@ -9254,6 +9300,24 @@ packages: typedarray-to-buffer@3.1.5: resolution: {integrity: sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==} + typedoc-docusaurus-theme@1.4.2: + resolution: {integrity: sha512-i9YYDcScLD0WUiX8I+LXHX3ZVvRDlJsmRo9l/uWrFT37cHlMz4Ay0GOnWzHUBnnwAo1uzYOw9RjUXznbWozBEA==} + peerDependencies: + typedoc-plugin-markdown: '>=4.8.0' + + typedoc-plugin-markdown@4.9.0: + resolution: {integrity: sha512-9Uu4WR9L7ZBgAl60N/h+jqmPxxvnC9nQAlnnO/OujtG2ubjnKTVUFY1XDhcMY+pCqlX3N2HsQM2QTYZIU9tJuw==} + engines: {node: '>= 18'} + peerDependencies: + typedoc: 0.28.x + + typedoc@0.28.15: + resolution: {integrity: sha512-mw2/2vTL7MlT+BVo43lOsufkkd2CJO4zeOSuWQQsiXoV2VuEn7f6IZp2jsUDPmBMABpgR0R5jlcJ2OGEFYmkyg==} + engines: {node: '>= 18', pnpm: '>= 10'} + hasBin: true + peerDependencies: + typescript: 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x || 5.9.x + typescript-eslint@8.49.0: resolution: {integrity: sha512-zRSVH1WXD0uXczCXw+nsdjGPUdx4dfrs5VQoHnUWmv1U3oNlAKv4FUNdLDhVUg+gYn+a5hUESqch//Rv5wVhrg==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} @@ -9275,6 +9339,9 @@ packages: resolution: {integrity: sha512-ya4mg/30vm+DOWfBg4YK3j2WD6TWtRkCbasOJr40CseYENzCUby/7rIvXA99JGsQHeNxLbnXdyLLxKSv3tauFw==} engines: {node: '>=12.17'} + uc.micro@2.1.0: + resolution: {integrity: sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==} + uglify-js@3.19.3: resolution: {integrity: sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ==} engines: {node: '>=0.8.0'} @@ -12226,6 +12293,14 @@ snapshots: '@floating-ui/utils@0.2.10': {} + '@gerrit0/mini-shiki@3.20.0': + dependencies: + '@shikijs/engine-oniguruma': 3.20.0 + '@shikijs/langs': 3.20.0 + '@shikijs/themes': 3.20.0 + '@shikijs/types': 3.20.0 + '@shikijs/vscode-textmate': 10.0.2 + '@grpc/grpc-js@1.14.1': dependencies: '@grpc/proto-loader': 0.8.0 @@ -13973,6 +14048,26 @@ snapshots: '@rollup/rollup-win32-x64-msvc@4.52.4': optional: true + '@shikijs/engine-oniguruma@3.20.0': + dependencies: + '@shikijs/types': 3.20.0 + '@shikijs/vscode-textmate': 10.0.2 + + '@shikijs/langs@3.20.0': + dependencies: + '@shikijs/types': 3.20.0 + + '@shikijs/themes@3.20.0': + dependencies: + '@shikijs/types': 3.20.0 + + '@shikijs/types@3.20.0': + dependencies: + '@shikijs/vscode-textmate': 10.0.2 + '@types/hast': 3.0.4 + + '@shikijs/vscode-textmate@10.0.2': {} + '@sideway/address@4.1.5': dependencies: '@hapi/hoek': 9.3.0 @@ -15931,6 +16026,11 @@ snapshots: unified: 9.2.2 unist-util-is: 4.1.0 + docusaurus-plugin-typedoc@1.4.2(typedoc-plugin-markdown@4.9.0(typedoc@0.28.15(typescript@5.6.3))): + dependencies: + typedoc-docusaurus-theme: 1.4.2(typedoc-plugin-markdown@4.9.0(typedoc@0.28.15(typescript@5.6.3))) + typedoc-plugin-markdown: 4.9.0(typedoc@0.28.15(typescript@5.6.3)) + dom-accessibility-api@0.5.16: {} dom-converter@0.2.0: @@ -17611,6 +17711,10 @@ snapshots: lines-and-columns@1.2.4: {} + linkify-it@5.0.0: + dependencies: + uc.micro: 2.1.0 + lint-staged@15.5.2: dependencies: chalk: 5.6.2 @@ -17746,6 +17850,15 @@ snapshots: markdown-extensions@2.0.0: {} + markdown-it@14.1.0: + dependencies: + argparse: 2.0.1 + entities: 4.5.0 + linkify-it: 5.0.0 + mdurl: 2.0.0 + punycode.js: 2.3.1 + uc.micro: 2.1.0 + markdown-table@2.0.0: dependencies: repeat-string: 1.6.1 @@ -17950,6 +18063,8 @@ snapshots: mdn-data@2.12.2: {} + mdurl@2.0.0: {} + media-typer@0.3.0: {} memfs@4.51.1: @@ -19287,6 +19402,8 @@ snapshots: picocolors: 1.1.1 sade: 1.8.1 + punycode.js@2.3.1: {} + punycode@2.3.1: {} pupa@3.3.0: @@ -20475,6 +20592,23 @@ snapshots: dependencies: is-typedarray: 1.0.0 + typedoc-docusaurus-theme@1.4.2(typedoc-plugin-markdown@4.9.0(typedoc@0.28.15(typescript@5.6.3))): + dependencies: + typedoc-plugin-markdown: 4.9.0(typedoc@0.28.15(typescript@5.6.3)) + + typedoc-plugin-markdown@4.9.0(typedoc@0.28.15(typescript@5.6.3)): + dependencies: + typedoc: 0.28.15(typescript@5.6.3) + + typedoc@0.28.15(typescript@5.6.3): + dependencies: + '@gerrit0/mini-shiki': 3.20.0 + lunr: 2.3.9 + markdown-it: 14.1.0 + minimatch: 9.0.5 + typescript: 5.6.3 + yaml: 2.8.1 + typescript-eslint@8.49.0(eslint@9.39.1(jiti@2.6.1))(typescript@5.9.3): dependencies: '@typescript-eslint/eslint-plugin': 8.49.0(@typescript-eslint/parser@8.49.0(eslint@9.39.1(jiti@2.6.1))(typescript@5.9.3))(eslint@9.39.1(jiti@2.6.1))(typescript@5.9.3) @@ -20492,6 +20626,8 @@ snapshots: typical@7.3.0: {} + uc.micro@2.1.0: {} + uglify-js@3.19.3: optional: true