docs: generate API reference docs from TS packages

.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
 

biome.json

@@ -16,7 +16,8 @@
       "!**/coverage",
       "!packages/appkit-ui/src/react/ui",
       "!**/routeTree.gen.ts",
-      "!docs/.docusaurus"
+      "!docs/.docusaurus",
+      "!**/typedoc-sidebar.ts"
     ]
   },
   "formatter": {

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`