skeleton Documentation

Skeleton is an adaptive design system powered by Tailwind CSS.

6,080 stars TypeScript TypeScript 12 files · ~156,158 tokens #a11y#accessibility#astro#components#components-library#design#design-system#nextjs
RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy skeleton on any server, homelab, or cloud container platform.

1-Click Terminal Command
bash (docker run) 
docker run -d --name skeleton -p 5432:5432 --restart always postgres:17
Configured Services & Ports
⚙️ postgres
image: postgres:17
🔌 Ports: 5432:5432
⚙️ oauth2-server
image: ghcr.io/navikt/mock-oauth2-server:3.0.3
🔌 Ports: 8080:8080
docker-compose.yml
yaml (docker-compose.yml) 
name: plus-skeleton-dev

services:
  postgres:
    image: postgres:17
    restart: unless-stopped
    ports:
      - 5432:5432
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
      POSTGRES_DB: postgres
    volumes:
      - pgdata:/var/lib/postgresql/data

  oauth2-server:
    image: ghcr.io/navikt/mock-oauth2-server:3.0.3
    restart: unless-stopped
    ports:
      - 8080:8080
    hostname: host.docker.internal
    environment:
      JSON_CONFIG: |
        {
          "httpServer": "NettyWrapper",
          "tokenCallbacks": [
            {
              "issuerId": "local",
              "tokenExpiry": 120,
              "requestMappings": [
                {
                  "requestParam": "code",
                  "match": "*",
                  "claims": {
                    "sub": "john-doe",
                    "name": "John Doe",
                    "email": "[email protected]",
                    "email_verified": true,
                    "picture": "https://i.pravatar.cc/100",
                    "aud": ["test-client-id"],
                    "scope": ["openid", "profile"]
                  }
                }
              ]
            }
          ]
        }

volumes:
  pgdata:

Technical Documentation: skeletonlabs/skeleton

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`)

Skeleton






Skeleton uses Tailwind CSS as the foundation for building adaptive design systems. Including turnkey components for your favorite web frameworks.

📖 Get Started

👥 Community

🤝 Support

🛠️ Contribute

Browse the contribution guidelines to help you get started.

Maintainers

Created by Chris Simmons (@endigo9740) and maintained by Skeleton Labs and the open source community.

Overview (`packages/cli/README.md`)

Skeleton CLI

Installation

bash
pnpm add skeleton

Documentation

Explore the full documentation at skeleton.dev.

Overview (`packages/docs/README.md`)

Docs

Installation

bash
pnpm add @skeletonlabs/component-types

Documentation

Explore the full documentation at skeleton.dev.

Overview (`packages/skeleton-common/README.md`)

Skeleton Common

Installation

bash
pnpm add @skeletonlabs/skeleton-common

Documentation

Explore the full documentation at skeleton.dev.

Overview (`packages/skeleton-react/README.md`)

Skeleton React

Installation

bash
pnpm add @skeletonlabs/skeleton-react

Documentation

Explore the full documentation at skeleton.dev.

Overview (`packages/skeleton-svelte/README.md`)

Skeleton Svelte

Installation

bash
pnpm add @skeletonlabs/skeleton-svelte

Documentation

Explore the full documentation at skeleton.dev.

Overview (`packages/skeleton/README.md`)

Skeleton

Installation

bash
pnpm add @skeletonlabs/skeleton

Documentation

Explore the full documentation at skeleton.dev.

Overview (`sites/plus.skeleton.dev/README.md`)

plus.skeleton.dev

Prerequisites

Please ensure you have the following software installed:

Environment Variables

See .env.example.

Note: For local development, you only need to populate the DATABASE_URL variable set to your local database instance, the docker container postgres database defaults to postgres://postgres:postgres@localhost:5432/postgres

Developing

  1. Run pnpm env:start (This will spin up the docker container containing both a local postgres database and local oauth server)
  2. Run pnpm drizzle:push (if this is your first time spinning up the docker container to sync our Drizzle schema to the local database, otherwise you may skip this step)
  3. Run pnpm dev

Once you're done you can run pnpm env:stop to spin the container down.

Packages Docs CHANGELOG (`packages/docs/CHANGELOG.md`)

@skeletonlabs/docs

5.0.1

5.0.0

Minor Changes

  • feature: QrCode component (#4394)

Patch Changes

5.0.0-next.12

5.0.0-next.11

5.0.0-next.10

Minor Changes

  • feature: QrCode component (#4394)

5.0.0-next.9

5.0.0-next.8

Patch Changes

Packages Docs Package.Json (`packages/docs/package.json`)

{
"name": "@skeletonlabs/docs",
"version": "5.0.1",
"description": "Documentation generator for various Skeleton packages",
"repository": {
"type": "git",
"url": "git+https://github.com/skeletonlabs/skeleton.git",
"directory": "packages/docs"
},
"files": [
"data"
],
"sideEffects": false,
"scripts": {
"generate": "node ./src/index.ts",
"check": "tsc",
"prepack": "clean-package",
"postpack": "clean-package restore"
},
"exports": {
"./components.json": "./data/components.json"
},
"devDependencies": {
"@types/node": "catalog:",
"clean-package": "catalog:",
"svelte": "catalog:",
"tinyglobby": "catalog:",
"ts-morph": "catalog:",
"typescript": "catalog:",
"@clack/prompts": "catalog:"
},
"license": "MIT",
"type": "module",
"clean-package": {
"remove": [
"scripts",
"devDependencies",
"clean-package"
]
}
}

Packages Docs Tsconfig.Json (`packages/docs/tsconfig.json`)

{
"compilerOptions": {
"module": "nodenext",
"moduleResolution": "nodenext",
"esModuleInterop": true,
"skipLibCheck": true,
"target": "es2022",
"allowJs": true,
"resolveJsonModule": true,
"moduleDetection": "force",
"rewriteRelativeImportExtensions": true,
"isolatedModules": true,
"strict": true,
"noUncheckedIndexedAccess": true,
"noImplicitOverride": true,
"declaration": true,
"noEmit": true,
"lib": ["es2022"]
},
"include": ["src"]
}

Packages Docs Data Components.Json (`packages/docs/data/components.json`)

[
{
"framework": "react",
"components": [
{
"name": "accordion",
"types": [
{
"name": "AccordionRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; item: (value: string) => string; itemContent: (value: string) => string; itemTrigger: (value: string) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the accordion. Useful for composition.",
"tags": []
}
},
{
"name": "multiple",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether multiple accordion items can be expanded at the same time.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "collapsible",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether an accordion item can be closed after it has been expanded.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "value",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled value of the expanded accordion items.",
"tags": []
}
},
{
"name": "defaultValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial value of the expanded accordion items.\nUse when you don't need to control the value of the accordion.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the accordion items are disabled",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The callback fired when the state of expanded/collapsed accordion items changes.",
"tags": []
}
},
{
"name": "onFocusChange",
"type": "((details: FocusChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The callback fired when the focused accordion item changes.",
"tags": []
}
},
{
"name": "orientation",
"type": ""horizontal" | "vertical" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The orientation of the accordion items.",
"tags": [
{
"name": "default",
"value": ""vertical""
}
]
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AccordionRootProviderProps",
"props": [
{
"name": "value",
"type": "AccordionApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AccordionRootContextProps",
"props": [
{
"name": "children",
"type": "(accordion: AccordionApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "AccordionItemProps",
"props": [
{
"name": "value",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The value of the accordion item.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the accordion item is disabled.",
"tags": []
}
},
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AccordionItemTriggerProps",
"props": [
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AccordionItemIndicatorProps",
"props": [
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AccordionItemContentProps",
"props": [
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "app-bar",
"types": [
{
"name": "AppBarRootProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"header">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AppBarToolbarProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AppBarLeadProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"nav">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AppBarHeadlineProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AppBarTrailProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"nav">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "avatar",
"types": [
{
"name": "AvatarRootProps",
"props": [
{
"name": "onStatusChange",
"type": "((details: StatusChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Functional called when the image loading status changes.",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ root: string; image: string; fallback: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the avatar. Useful for composition.",
"tags": []
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AvatarRootProviderProps",
"props": [
{
"name": "value",
"type": "AvatarApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AvatarRootContextProps",
"props": [
{
"name": "children",
"type": "(avatar: AvatarApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "AvatarImageProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"img">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AvatarFallbackProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "carousel",
"types": [
{
"name": "CarouselRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; item: (index: number) => string; itemGroup: string; nextTrigger: string; prevTrigger: string; indicatorGroup: string; indicator: (index: number) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the carousel. Useful for composition.",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The localized messages to use.",
"tags": []
}
},
{
"name": "slidesPerPage",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The number of slides to show at a time.",
"tags": [
{
"name": "default",
"value": "1"
}
]
}
},
{
"name": "autoSize",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to enable variable width slides.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "slidesPerMove",
"type": "number | "auto" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The number of slides to scroll at a time.\n\nWhen set to auto, the number of slides to scroll is determined by the\nslidesPerPage property.",
"tags": [
{
"name": "default",
"value": ""auto""
}
]
}
},
{
"name": "autoplay",
"type": "boolean | { delay: number; } | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "Whether to scroll automatically. The default delay is 4000ms.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "allowMouseDrag",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to allow scrolling via dragging with mouse",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "loop",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the carousel should loop around.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "page",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled page of the carousel.",
"tags": []
}
},
{
"name": "defaultPage",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial page to scroll to when rendered.\nUse when you don't need to control the page of the carousel.",
"tags": [
{
"name": "default",
"value": "0"
}
]
}
},
{
"name": "spacing",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The amount of space between items.",
"tags": [
{
"name": "default",
"value": ""0px""
}
]
}
},
{
"name": "padding",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Defines the extra space added around the scrollable area,\nenabling nearby items to remain partially in view.",
"tags": []
}
},
{
"name": "onPageChange",
"type": "((details: PageChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the page changes.",
"tags": []
}
},
{
"name": "inViewThreshold",
"type": "number | number[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The threshold for determining if an item is in view.",
"tags": [
{
"name": "default",
"value": "0.6"
}
]
}
},
{
"name": "snapType",
"type": ""proximity" | "mandatory" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The snap type of the item.",
"tags": [
{
"name": "default",
"value": ""mandatory""
}
]
}
},
{
"name": "slideCount",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The total number of slides.\nUseful for SSR to render the initial ating the snap points.",
"tags": []
}
},
{
"name": "onDragStatusChange",
"type": "((details: DragStatusDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the drag status changes.",
"tags": []
}
},
{
"name": "onAutoplayStatusChange",
"type": "((details: AutoplayStatusDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the autoplay status changes.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "orientation",
"type": ""horizontal" | "vertical" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The orientation of the element.",
"tags": [
{
"name": "default",
"value": ""horizontal""
}
]
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselRootProviderProps",
"props": [
{
"name": "value",
"type": "CarouselApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselRootContextProps",
"props": [
{
"name": "children",
"type": "(carousel: CarouselApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "CarouselControlProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselItemGroupProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselItemProps",
"props": [
{
"name": "index",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The index of the item.",
"tags": []
}
},
{
"name": "snapAlign",
"type": ""start" | "end" | "center" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The snap alignment of the item.",
"tags": [
{
"name": "default",
"value": ""start""
}
]
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselPrevTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselNextTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselAutoplayTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselIndicatorGroupProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselIndicatorProps",
"props": [
{
"name": "index",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The index of the indicator.",
"tags": []
}
},
{
"name": "readOnly",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the indicator is read only.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselProgressTextProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "collapsible",
"types": [
{
"name": "CollapsibleRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; content: string; trigger: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the collapsible. Useful for composition.",
"tags": []
}
},
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the collapsible.",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the collapsible when rendered.\nUse when you don't need to control the open state of the collapsible.",
"tags": []
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The callback invoked when the open state changes.",
"tags": []
}
},
{
"name": "onExitComplete",
"type": "VoidFunction | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The callback invoked when the exit animation completes.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the collapsible is disabled.",
"tags": []
}
},
{
"name": "collapsedHeight",
"type": "string | number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The height of the content when collapsed.",
"tags": []
}
},
{
"name": "collapsedWidth",
"type": "string | number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The width of the content when collapsed.",
"tags": []
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CollapsibleRootProviderProps",
"props": [
{
"name": "value",
"type": "CollapsibleApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CollapsibleRootContextProps",
"props": [
{
"name": "children",
"type": "(collapsible: CollapsibleApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "CollapsibleTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CollapsibleIndicatorProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CollapsibleContentProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "combobox",
"types": [
{
"name": "ComboboxRootProps",
"props": [
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the combobox",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the combobox when rendered.\nUse when you don't need to control the open state of the combobox.",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ root: string; label: string; control: string; input: string; content: string; trigger: string; clearTrigger: string; item: (id: string, index?: number | undefined) => string; positioner: string; itemGroup: (id: string | number) => string; itemGroupLabel: (id: string | number) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the combobox. Useful for composition.",
"tags": []
}
},
{
"name": "inputValue",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled value of the combobox's input",
"tags": []
}
},
{
"name": "defaultInputValue",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial value of the combobox's input when rendered.\nUse when you don't need to control the value of the combobox's input.",
"tags": [
{
"name": "default",
"value": """"
}
]
}
},
{
"name": "name",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The name attribute of the combobox's input. Useful for form submission",
"tags": []
}
},
{
"name": "form",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The associate form of the combobox.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the combobox is disabled",
"tags": []
}
},
{
"name": "readOnly",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the combobox is readonly. This puts the combobox in a "non-editable" mode\nbut the user can still interact with it",
"tags": []
}
},
{
"name": "invalid",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the combobox is invalid",
"tags": []
}
},
{
"name": "required",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the combobox is required",
"tags": []
}
},
{
"name": "placeholder",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The placeholder text of the combobox's input",
"tags": []
}
},
{
"name": "defaultHighlightedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial highlighted value of the combobox when rendered.\nUse when you don't need to control the highlighted value of the combobox.",
"tags": []
}
},
{
"name": "highlightedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled highlighted value of the combobox",
"tags": []
}
},
{
"name": "value",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled value of the combobox's selected items",
"tags": []
}
},
{
"name": "defaultValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial value of the combobox's selected items when rendered.\nUse when you don't need to control the value of the combobox's selected items.",
"tags": [
{
"name": "default",
"value": "[]"
}
]
}
},
{
"name": "inputBehavior",
"type": ""autohighlight" | "autocomplete" | "none" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Defines the auto-completion behavior of the combobox.\n\n- autohighlight: The first focused item is highlighted as the user types\n- autocomplete: Navigating the listbox with the arrow keys selects the item and the input is updated",
"tags": [
{
"name": "default",
"value": ""none""
}
]
}
},
{
"name": "selectionBehavior",
"type": ""clear" | "replace" | "preserve" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The behavior of the combobox input when an item is selected\n\n- replace: The selected item string is set as the input value\n- clear: The input value is cleared\n- preserve: The input value is preserved",
"tags": [
{
"name": "default",
"value": ""replace""
}
]
}
},
{
"name": "autoFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to autofocus the input on mount",
"tags": []
}
},
{
"name": "openOnClick",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to open the combobox popup on initial click on the input",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "openOnChange",
"type": "boolean | ((details: InputValueChangeDetails) => boolean) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Whether to show the combobox when the input value changes",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "allowCustomValue",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to allow typing custom values in the input",
"tags": []
}
},
{
"name": "alwaysSubmitOnEnter",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to always submit on Enter key press, even if popup is open.\nUseful for single-field autocomplete forms where Enter should submit the form.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "loopFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to loop the keyboard navigation through the items",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "positioning",
"type": "PositioningOptions | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The positioning options to dynamically position the menu",
"tags": [
{
"name": "default",
"value": "{ placement: "bottom-start" }"
}
]
}
},
{
"name": "onInputValueChange",
"type": "((details: InputValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the input's value changes",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when a new item is selected",
"tags": []
}
},
{
"name": "onHighlightChange",
"type": "((details: HighlightChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an item is highlighted using the pointer\nor keyboard navigation.",
"tags": []
}
},
{
"name": "onSelect",
"type": "((details: SelectionDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an item is selected",
"tags": []
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the popup is opened",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "Specifies the localized strings that identifies the accessibility elements and their states",
"tags": []
}
},
{
"name": "collection",
"type": "ListCollection | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The collection of items",
"tags": []
}
},
{
"name": "multiple",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to allow multiple selection.\n\nGood to know: When multiple is true, the selectionBehavior is automatically set to clear.\nIt is recommended to render the selected items in a separate container.",
"tags": []
}
},
{
"name": "closeOnSelect",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the combobox when an item is selected.",
"tags": []
}
},
{
"name": "openOnKeyPress",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to open the combobox on arrow key press",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "scrollToIndexFn",
"type": "((details: ScrollToIndexDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to scroll to a specific index",
"tags": []
}
},
{
"name": "composite",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the combobox is a composed with other composite widgets like tabs",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "disableLayer",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to disable registering this a dismissable layer",
"tags": []
}
},
{
"name": "navigate",
"type": "((details: NavigateDetails) => void) | null | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to navigate to the selected item",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "onPointerDownOutside",
"type": "((event: PointerDownOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the pointer is pressed down outside the component",
"tags": []
}
},
{
"name": "onFocusOutside",
"type": "((event: FocusOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the focus is moved outside the component",
"tags": []
}
},
{
"name": "onInteractOutside",
"type": "((event: InteractOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an interaction happens outside the component",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxRootProviderProps",
"props": [
{
"name": "value",
"type": "ComboboxApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxRootContextProps",
"props": [
{
"name": "children",
"type": "(combobox: ComboboxApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "ComboboxLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"label">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxControlProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxInputProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"input">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxClearTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxPositionerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxContentProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"ul">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxItemGroupProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxItemGroupLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxItemProps",
"props": [
{
"name": "persistFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether hovering outside should clear the highlighted state",
"tags": []
}
},
{
"name": "item",
"type": "any",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The item to render",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"li">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxItemTextProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxItemIndicatorProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "date-picker",
"types": [
{
"name": "DatePickerRootProps",
"props": [
{
"name": "locale",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The locale (BCP 47 language tag) to use when formatting the date.",
"tags": [
{
"name": "default",
"value": ""en-US""
}
]
}
},
{
"name": "createCalendar",
"type": "((identifier: CalendarIdentifier) => Calendar) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A function that creates a Calendar object for a given calendar identifier.\nEnables non-Gregorian calendar support (Persian, Buddhist, Islamic, etc.)\nwithout bundling all calendars by default.",
"tags": [
{
"name": "example",
"value": "import { createCalendar } from "@internationalized/date"\n{ locale: "fa-IR", createCalendar }"
}
]
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The localized messages to use.",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ root: string; label: (index: number) => string; table: (id: string) => string; tableHeader: (id: string) => string; tableBody: (id: string) => string; tableRow: (id: string) => string; ... 11 more ...; positioner: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the date picker. Useful for composition.",
"tags": []
}
},
{
"name": "name",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The name attribute of the input element.",
"tags": []
}
},
{
"name": "timeZone",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The time zone to use",
"tags": [
{
"name": "default",
"value": ""UTC""
}
]
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the calendar is disabled.",
"tags": []
}
},
{
"name": "readOnly",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the calendar is read-only.",
"tags": []
}
},
{
"name": "required",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the date picker is required",
"tags": []
}
},
{
"name": "invalid",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the date picker is invalid",
"tags": []
}
},
{
"name": "outsideDaySelectable",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether day outside the visible range can be selected.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "min",
"type": "DateValue | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The minimum date that can be selected.",
"tags": []
}
},
{
"name": "max",
"type": "DateValue | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The maximum date that can be selected.",
"tags": []
}
},
{
"name": "closeOnSelect",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the calendar should close after the date selection is complete.\nThis is ignored when the selection mode is multiple.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "openOnClick",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to open the calendar when the input is clicked.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "value",
"type": "DateValue[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled selected date(s).",
"tags": []
}
},
{
"name": "defaultValue",
"type": "DateValue[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial selected date(s) when rendered.\nUse when you don't need to control the selected date(s) of the date picker.",
"tags": []
}
},
{
"name": "focusedValue",
"type": "DateValue | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The controlled focused date.",
"tags": []
}
},
{
"name": "defaultFocusedValue",
"type": "DateValue | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The initial focused date when rendered.\nUse when you don't need to control the focused date of the date picker.",
"tags": []
}
},
{
"name": "numOfMonths",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The number of months to display.",
"tags": []
}
},
{
"name": "startOfWeek",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The first day of the week.\n 0 - Sunday\n 1 - Monday\n 2 - Tuesday\n 3 - Wednesday\n 4 - Thursday\n 5 - Friday\n 6 - Saturday",
"tags": []
}
},
{
"name": "fixedWeeks",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the calendar should have a fixed number of weeks.\nThis renders the calendar with 6 weeks instead of 5 or 6.",
"tags": []
}
},
{
"name": "showWeekNumbers",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to show the week number column in the day view.",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the value changes.",
"tags": []
}
},
{
"name": "onFocusChange",
"type": "((details: FocusChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the focused date changes.",
"tags": []
}
},
{
"name": "onViewChange",
"type": "((details: ViewChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the view changes.",
"tags": []
}
},
{
"name": "onVisibleRangeChange",
"type": "((details: VisibleRangeChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the visible range changes.",
"tags": []
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the calendar opens or closes.",
"tags": []
}
},
{
"name": "isDateUnavailable",
"type": "((date: DateValue, locale: string) => boolean) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Returns whether a date of the calendar is available.",
"tags": []
}
},
{
"name": "selectionMode",
"type": "SelectionMode | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The selection mode of the calendar.\n- single - only one date can be selected\n- multiple - multiple dates can be selected\n- range - a range of dates can be selected",
"tags": [
{
"name": "default",
"value": ""single""
}
]
}
},
{
"name": "maxSelectedDates",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The maximum number of dates that can be selected.\nThis is only applicable when selectionMode is multiple.",
"tags": []
}
},
{
"name": "format",
"type": "((date: DateValue, details: LocaleDetails) => string) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The format of the date to display in the input.",
"tags": []
}
},
{
"name": "parse",
"type": "((value: string, details: LocaleDetails) => DateValue | undefined) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to parse the date from the input back to a DateValue.",
"tags": []
}
},
{
"name": "placeholder",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The placeholder text to display in the input.",
"tags": []
}
},
{
"name": "view",
"type": "DateView | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The view of the calendar",
"tags": []
}
},
{
"name": "defaultView",
"type": "DateView | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The default view of the calendar",
"tags": [
{
"name": "default",
"value": ""day""
}
]
}
},
{
"name": "minView",
"type": "DateView | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The minimum view of the calendar",
"tags": [
{
"name": "default",
"value": ""day""
}
]
}
},
{
"name": "maxView",
"type": "DateView | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The maximum view of the calendar",
"tags": [
{
"name": "default",
"value": ""year""
}
]
}
},
{
"name": "positioning",
"type": "PositioningOptions | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The user provided options used to position the date picker content",
"tags": []
}
},
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the date picker",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the date picker when rendered.\nUse when you don't need to control the open state of the date picker.",
"tags": []
}
},
{
"name": "inline",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to render the date picker inline",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerRootProviderProps",
"props": [
{
"name": "value",
"type": "DatePickerApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerRootContextProps",
"props": [
{
"name": "children",
"type": "(datePicker: DatePickerApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "DatePickerLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"label">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerControlProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerPresetTriggerProps",
"props": [
{
"name": "value",
"type": "PresetTriggerValue",
"typeKind": "array",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerInputProps",
"props": [
{
"name": "index",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The index of the input to focus.",
"tags": []
}
},
{
"name": "fixOnBlur",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to fix the input value on blur.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"input">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerPositionerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerContentProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerYearSelectProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"select">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerMonthSelectProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"select">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerViewProps",
"props": [
{
"name": "view",
"type": "DateView | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerViewControlProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerPrevTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerViewTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerRangeTextProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerNextTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"table">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableHeadProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"thead">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableRowProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"tr">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableHeaderProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"th">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableBodyProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"tbody">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableCellProps",
"props": [
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "value",
"type": "number | DateValue",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "columns",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "visibleRange",
"type": "VisibleRange | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"td">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableCellTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "dialog",
"types": [
{
"name": "DialogRootProps",
"props": [
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ trigger: string | ((value?: string | undefined) => string); positioner: string; backdrop: string; content: string; closeTrigger: string; title: string; description: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the dialog. Useful for composition.",
"tags": []
}
},
{
"name": "trapFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to trap focus inside the dialog when it's opened",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "preventScroll",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to prevent scrolling behind the dialog when it's opened",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "modal",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to prevent pointer interaction outside the element and hide all content below it",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "initialFocusEl",
"type": "(() => MaybeElement) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Element to receive focus when the dialog is opened",
"tags": []
}
},
{
"name": "finalFocusEl",
"type": "(() => MaybeElement) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Element to receive focus when the dialog is closed",
"tags": []
}
},
{
"name": "restoreFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to restore focus to the element that had focus before the dialog was opened",
"tags": []
}
},
{
"name": "closeOnInteractOutside",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the dialog when the outside is clicked",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "closeOnEscape",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the dialog when the escape key is pressed",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "aria-label",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Human readable label for the dialog, in event the dialog title is not rendered",
"tags": []
}
},
{
"name": "role",
"type": ""dialog" | "alertdialog" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The dialog's role",
"tags": [
{
"name": "default",
"value": ""dialog""
}
]
}
},
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the dialog",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the dialog when rendered.\nUse when you don't need to control the open state of the dialog.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to call when the dialog's open state changes",
"tags": []
}
},
{
"name": "triggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled active trigger value",
"tags": []
}
},
{
"name": "defaultTriggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial active trigger value when rendered.\nUse when you don't need to control the active trigger value.",
"tags": []
}
},
{
"name": "onTriggerValueChange",
"type": "((details: TriggerValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to call when the active trigger changes",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "onEscapeKeyDown",
"type": "((event: KeyboardEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the escape key is pressed",
"tags": []
}
},
{
"name": "onRequestDismiss",
"type": "((event: LayerDismissEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when this layer is closed due to a parent layer being closed",
"tags": []
}
},
{
"name": "onPointerDownOutside",
"type": "((event: PointerDownOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the pointer is pressed down outside the component",
"tags": []
}
},
{
"name": "onFocusOutside",
"type": "((event: FocusOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the focus is moved outside the component",
"tags": []
}
},
{
"name": "onInteractOutside",
"type": "((event: InteractOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an interaction happens outside the component",
"tags": []
}
},
{
"name": "persistentElements",
"type": "(() => Element | null)[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "Returns the persistent elements that:\n- should not have pointer-events disabled\n- should not trigger the dismiss event",
"tags": []
}
}
]
},
{
"name": "DialogRootProviderProps",
"props": [
{
"name": "value",
"type": "DialogApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "DialogRootContextProps",
"props": [
{
"name": "children",
"type": "(dialog: DialogApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "DialogTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DialogBackdropProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DialogPositionerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DialogContentProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DialogTitleProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DialogDescriptionProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DialogCloseTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "file-upload",
"types": [
{
"name": "FileUploadRootProps",
"props": [
{
"name": "name",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The name of the underlying file input",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ root: string; dropzone: string; hiddenInput: string; trigger: string; label: string; item: (id: string) => string; itemName: (id: string) => string; itemSizeText: (id: string) => string; itemPreview: (id: string) => string; itemDeleteTrigger: (id: string) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements. Useful for composition.",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The localized messages to use.",
"tags": []
}
},
{
"name": "accept",
"type": "Record<string, string[]> | FileMimeType | FileMimeType[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The accept file types",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the file input is disabled",
"tags": []
}
},
{
"name": "required",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the file input is required",
"tags": []
}
},
{
"name": "allowDrop",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to allow drag and drop in the dropzone element",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "maxFileSize",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The maximum file size in bytes",
"tags": [
{
"name": "default",
"value": "Infinity"
}
]
}
},
{
"name": "minFileSize",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The minimum file size in bytes",
"tags": [
{
"name": "default",
"value": "0"
}
]
}
},
{
"name": "maxFiles",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The maximum number of files",
"tags": [
{
"name": "default",
"value": "1"
}
]
}
},
{
"name": "preventDocumentDrop",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to prevent the drop event on the document",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "validate",
"type": "((file: File, details: FileValidateDetails) => FileError[] | null) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to validate a file",
"tags": []
}
},
{
"name": "defaultAcceptedFiles",
"type": "File[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The default accepted files when rendered.\nUse when you don't need to control the accepted files of the input.",
"tags": []
}
},
{
"name": "acceptedFiles",
"type": "File[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled accepted files",
"tags": []
}
},
{
"name": "onFileChange",
"type": "((details: FileChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the value changes, whether accepted or rejected",
"tags": []
}
},
{
"name": "onFileAccept",
"type": "((details: FileAcceptDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the file is accepted",
"tags": []
}
},
{
"name": "onFileReject",
"type": "((details: FileRejectDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the file is rejected",
"tags": []
}
},
{
"name": "capture",
"type": ""user" | "environment" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The default camera to use when capturing media",
"tags": []
}
},
{
"name": "directory",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to accept directories, only works in webkit browsers",
"tags": []
}
},
{
"name": "invalid",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the file input is invalid",
"tags": []
}
},
{
"name": "readOnly",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the file input is read-only",
"tags": []
}
},
{
"name": "transformFiles",
"type": "((files: File[]) => Promise<File[]>) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to transform the accepted files to apply transformations",
"tags": []
}
},
{
"name": "locale",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The current locale. Based on the BCP 47 definition.",
"tags": [
{
"name": "default",
"value": ""en-US""
}
]
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadRootProviderProps",
"props": [
{
"name": "value",
"type": "FileUploadApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadRootContextProps",
"props": [
{
"name": "children",
"type": "(fileUpload: FileUploadApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "FileUploadLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"label">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadDropzoneProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadClearTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadHiddenInputProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"input">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadItemGroupProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"ul">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadItemProps",
"props": [
{
"name": "file",
"type": "File",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "type",
"type": "ItemType | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"li">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadItemNameProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadItemSizeTextProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadItemDeleteTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "floating-panel",
"types": [
{
"name": "FloatingPanelRootProps",
"props": [
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ trigger: string; positioner: string; content: string; title: string; header: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the floating panel. Useful for composition.",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The translations for the floating panel.",
"tags": []
}
},
{
"name": "strategy",
"type": ""absolute" | "fixed" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The strategy to use for positioning",
"tags": [
{
"name": "default",
"value": ""fixed""
}
]
}
},
{
"name": "allowOverflow",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel should be strictly contained within the boundary when dragging",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the panel",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the panel when rendered.\nUse when you don't need to control the open state of the panel.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "draggable",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel is draggable",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "resizable",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel is resizable",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "size",
"type": "Size | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The size of the panel",
"tags": []
}
},
{
"name": "defaultSize",
"type": "Size | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The default size of the panel",
"tags": []
}
},
{
"name": "minSize",
"type": "Size | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The minimum size of the panel",
"tags": []
}
},
{
"name": "maxSize",
"type": "Size | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The maximum size of the panel",
"tags": []
}
},
{
"name": "position",
"type": "Point | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The controlled position of the panel",
"tags": []
}
},
{
"name": "defaultPosition",
"type": "Point | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The initial position of the panel when rendered.\nUse when you don't need to control the position of the panel.",
"tags": []
}
},
{
"name": "getAnchorPosition",
"type": "((details: AnchorPositionDetails) => Point) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function that returns the initial position of the panel when it is opened.\nIf provided, will be used instead of the default position.",
"tags": []
}
},
{
"name": "lockAspectRatio",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel is locked to its aspect ratio",
"tags": []
}
},
{
"name": "closeOnEscape",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel should close when the escape key is pressed",
"tags": []
}
},
{
"name": "getBoundaryEl",
"type": "(() => HTMLElement | null) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The boundary of the panel. Useful for recalculating the boundary rect when\nthe it is resized.",
"tags": []
}
},
{
"name": "initialFocusEl",
"type": "(() => HTMLElement | null) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Element to receive focus when the panel is opened.\nBy default, the first focusable element in the content is focused.",
"tags": []
}
},
{
"name": "finalFocusEl",
"type": "(() => HTMLElement | null) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Element to receive focus when the panel is closed.\nBy default, the trigger element is focused.",
"tags": []
}
},
{
"name": "restoreFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to restore focus to the trigger when the panel is closed.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel is disabled",
"tags": []
}
},
{
"name": "onPositionChange",
"type": "((details: PositionChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the position of the panel changes via dragging",
"tags": []
}
},
{
"name": "onPositionChangeEnd",
"type": "((details: PositionChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the position of the panel changes via dragging ends",
"tags": []
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the panel is opened or closed",
"tags": []
}
},
{
"name": "onSizeChange",
"type": "((details: SizeChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the size of the panel changes via resizing",
"tags": []
}
},
{
"name": "onSizeChangeEnd",
"type": "((details: SizeChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the size of the panel changes via resizing ends",
"tags": []
}
},
{
"name": "persistRect",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel size and position should be preserved when it is closed",
"tags": []
}
},
{
"name": "gridSize",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The snap grid for the panel",
"tags": [
{
"name": "default",
"value": "1"
}
]
}
},
{
"name": "onStageChange",
"type": "((details: StageChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the stage of the panel changes",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
}
]
},
{
"name": "FloatingPanelRootProviderProps",
"props": [
{
"name": "value",
"type": "FloatingPanelApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "FloatingPanelRootContextProps",
"props": [
{
"name": "children",
"type": "(floatingPanel: FloatingPanelApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "FloatingPanelTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelPositionerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelContentProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelDragTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelHeaderProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelTitleProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelControlProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelStageTriggerProps",
"props": [
{
"name": "stage",
"type": "Stage",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The stage of the panel",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelCloseTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelBodyProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelResizeTriggerProps",
"props": [
{
"name": "axis",
"type": "ResizeTriggerAxis",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The axis of the resize handle",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "listbox",
"types": [
{
"name": "ListboxRootProps",
"props": [
{
"name": "orientation",
"type": ""horizontal" | "vertical" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The orientation of the listbox.",
"tags": [
{
"name": "default",
"value": ""vertical""
}
]
}
},
{
"name": "collection",
"type": "ListCollection | GridCollection",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": "The item collection",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ root: string; content: string; label: string; item: (id: string | number) => string; itemGroup: (id: string | number) => string; itemGroupLabel: (id: string | number) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the listbox. Useful for composition.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the listbox is disabled",
"tags": []
}
},
{
"name": "disallowSelectAll",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to disallow selecting all items when meta+a is pressed",
"tags": []
}
},
{
"name": "onHighlightChange",
"type": "((details: HighlightChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The callback fired when the highlighted item changes.",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The callback fired when the selected item changes.",
"tags": []
}
},
{
"name": "value",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled keys of the selected items",
"tags": []
}
},
{
"name": "defaultValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial default value of the listbox when rendered.\nUse when you don't need to control the value of the listbox.",
"tags": [
{
"name": "default",
"value": "[]"
}
]
}
},
{
"name": "highlightedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled key of the highlighted item",
"tags": []
}
},
{
"name": "defaultHighlightedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial value of the highlighted item when opened.\nUse when you don't need to control the highlighted value of the listbox.",
"tags": []
}
},
{
"name": "loopFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to loop the keyboard navigation through the options",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "selectionMode",
"type": "SelectionMode | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "How multiple selection should behave in the listbox.\n\n- single: The user can select a single item.\n- multiple: The user can select multiple items without using modifier keys.\n- extended: The user can select multiple items by using modifier keys.",
"tags": [
{
"name": "default",
"value": ""single""
}
]
}
},
{
"name": "scrollToIndexFn",
"type": "((details: ScrollToIndexDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to scroll to a specific index",
"tags": []
}
},
{
"name": "selectOnHighlight",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to select the item when it is highlighted",
"tags": []
}
},
{
"name": "deselectable",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to disallow empty selection",
"tags": []
}
},
{
"name": "typeahead",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to enable typeahead on the listbox",
"tags": []
}
},
{
"name": "onSelect",
"type": "((details: SelectionDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an item is selected",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxRootProviderProps",
"props": [
{
"name": "value",
"type": "ListboxApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxRootContextProps",
"props": [
{
"name": "children",
"type": "(listbox: ListboxApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "ListboxLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"label">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxInputProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"input">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxContentProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"ul">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxItemGroupProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxItemGroupLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxItemProps",
"props": [
{
"name": "item",
"type": "any",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The item to render",
"tags": []
}
},
{
"name": "highlightOnHover",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to highlight the item on hover",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"li">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxItemTextProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxItemIndicatorProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "locale-provider",
"types": [
{
"name": "LocaleProviderRootProps",
"props": [
{
"name": "locale",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The locale to use for the application.",
"tags": [
{
"name": "default",
"value": "'en-US'"
}
]
}
},
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "LocaleProviderRootContextProps",
"props": [
{
"name": "children",
"type": "(locale: Locale) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
}
]
},
{
"name": "marquee",
"types": [
{
"name": "MarqueeRootProps",
"props": [
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ root: string; viewport: string; content: (index: number) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the marquee. Useful for composition.",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The localized messages to use.",
"tags": []
}
},
{
"name": "side",
"type": "Side | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The side/direction the marquee scrolls towards.",
"tags": [
{
"name": "default",
"value": ""start""
}
]
}
},
{
"name": "speed",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The speed of the marquee animation in pixels per second.",
"tags": [
{
"name": "default",
"value": "50"
}
]
}
},
{
"name": "delay",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The delay before the animation starts (in seconds).",
"tags": [
{
"name": "default",
"value": "0"
}
]
}
},
{
"name": "loopCount",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The number of times to loop the animation (0 = infinite).",
"tags": [
{
"name": "default",
"value": "0"
}
]
}
},
{
"name": "spacing",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The spacing between marquee items.",
"tags": [
{
"name": "default",
"value": ""1rem""
}
]
}
},
{
"name": "autoFill",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to automatically duplicate content to fill the container.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "pauseOnInteraction",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to pause the marquee on user interaction (hover, focus).",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "reverse",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to reverse the animation direction.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "paused",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the marquee is paused.",
"tags": []
}
},
{
"name": "defaultPaused",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the marquee is paused by default.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "onPauseChange",
"type": "((details: PauseStatusDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the pause status changes.",
"tags": []
}
},
{
"name": "onLoopComplete",
"type": "(() => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the marquee completes one loop iteration.",
"tags": []
}
},
{
"name": "onComplete",
"type": "(() => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the marquee completes all loops and stops.\nOnly fires for finite loops (loopCount > 0).",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MarqueeRootProviderProps",
"props": [
{
"name": "value",
"type": "MarqueeApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MarqueeRootContextProps",
"props": [
{
"name": "children",
"type": "(marquee: MarqueeApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "MarqueeViewportProps",
"props": [
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MarqueeContentProps",
"props": [
{
"name": "index",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The index of the content instance (0 for original, 1+ for duplicates).",
"tags": []
}
},
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MarqueeEdgeProps",
"props": [
{
"name": "side",
"type": "Side",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The side where the edge gradient should appear.",
"tags": []
}
},
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "menu",
"types": [
{
"name": "MenuRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ trigger: string | ((value?: string | undefined) => string); contextTrigger: string | ((value?: string | undefined) => string); content: string; groupLabel: (id: string) => string; group: (id: string) => string; positioner: string; arrow: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the menu. Useful for composition.",
"tags": []
}
},
{
"name": "defaultHighlightedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial highlighted value of the menu item when rendered.\nUse when you don't need to control the highlighted value of the menu item.",
"tags": []
}
},
{
"name": "highlightedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled highlighted value of the menu item.",
"tags": []
}
},
{
"name": "onHighlightChange",
"type": "((details: HighlightChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the highlighted menu item changes.",
"tags": []
}
},
{
"name": "onSelect",
"type": "((details: SelectionDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when a menu item is selected.",
"tags": []
}
},
{
"name": "anchorPoint",
"type": "Point | null | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The positioning point for the menu. Can be set by the context menu trigger or the button trigger.",
"tags": []
}
},
{
"name": "loopFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to loop the keyboard navigation.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "positioning",
"type": "PositioningOptions | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The options used to dynamically position the menu",
"tags": []
}
},
{
"name": "closeOnSelect",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the menu when an option is selected",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "aria-label",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The accessibility label for the menu",
"tags": []
}
},
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the menu",
"tags": []
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the menu opens or closes",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the menu when rendered.\nUse when you don't need to control the open state of the menu.",
"tags": []
}
},
{
"name": "typeahead",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the pressing printable characters should trigger typeahead navigation",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "composite",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the menu is a composed with other composite widgets like a combobox or tabs",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "navigate",
"type": "((details: NavigateDetails) => void) | null | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to navigate to the selected item if it's an anchor element",
"tags": []
}
},
{
"name": "triggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled trigger value",
"tags": []
}
},
{
"name": "defaultTriggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial trigger value when rendered.\nUse when you don't need to control the trigger value.",
"tags": []
}
},
{
"name": "onTriggerValueChange",
"type": "((details: TriggerValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the trigger value changes.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "onEscapeKeyDown",
"type": "((event: KeyboardEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the escape key is pressed",
"tags": []
}
},
{
"name": "onRequestDismiss",
"type": "((event: LayerDismissEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when this layer is closed due to a parent layer being closed",
"tags": []
}
},
{
"name": "onPointerDownOutside",
"type": "((event: PointerDownOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the pointer is pressed down outside the component",
"tags": []
}
},
{
"name": "onFocusOutside",
"type": "((event: FocusOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the focus is moved outside the component",
"tags": []
}
},
{
"name": "onInteractOutside",
"type": "((event: InteractOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an interaction happens outside the component",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuRootProviderProps",
"props": [
{
"name": "value",
"type": "MenuApi & { service: MenuService; }",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "MenuRootContextProps",
"props": [
{
"name": "children",
"type": "(menu: MenuApi & { service: MenuService; }) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "MenuTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuContextTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuIndicatorProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuPositionerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuContentProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuItemGroupProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuItemGroupLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuItemProps",
"props": [
{
"name": "value",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The unique value of the menu item option.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the menu item is disabled",
"tags": []
}
},
{
"name": "valueText",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The textual value of the option. Used in typeahead navigation of the menu.\nIf not provided, the text content of the menu item will be used.",
"tags": []
}
},
{
"name": "closeOnSelect",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the menu should be closed when the option is selected.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuOptionItemProps",
"props": [
{
"name": "checked",
"type": "boolean",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "Whether the option is checked",
"tags": []
}
},
{
"name": "type",
"type": ""radio" | "checkbox"",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "Whether the option is a radio or a checkbox",
"tags": []
}
},
{
"name": "value",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The value of the option",
"tags": []
}
},
{
"name": "onCheckedChange",
"type": "((checked: boolean) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the option state is changed",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the menu item is disabled",
"tags": []
}
},
{
"name": "valueText",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The textual value of the option. Used in typeahead navigation of the menu.\nIf not provided, the text content of the menu item will be used.",
"tags": []
}
},
{
"name": "closeOnSelect",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the menu should be closed when the option is selected.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuTriggerItemProps",
"props": [
{
"name": "value",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The unique value of the menu item option.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the menu item is disabled",
"tags": []
}
},
{
"name": "valueText",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The textual value of the option. Used in typeahead navigation of the menu.\nIf not provided, the text content of the menu item will be used.",
"tags": []
}
},
{
"name": "closeOnSelect",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the menu should be closed when the option is selected.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuItemTextProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuItemIndicatorProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuSeparatorProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"hr">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuArrowProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuArrowTipProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "navigation",
"types": [
{
"name": "NavigationRootProps",
"props": [
{
"name": "layout",
"type": ""bar" | "rail" | "sidebar" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Sets the data-layout attribute, which modifies the visual presentation of the component set.",
"tags": [
{
"name": "default",
"value": "bar"
}
]
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationHeaderProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"header">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationContentProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationGroupProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationMenuProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationTriggerAnchorProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"a">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationTriggerTextProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationFooterProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"footer">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "pagination",
"types": [
{
"name": "PaginationRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; ellipsis: (index: number) => string; firstTrigger: string; prevTrigger: string; nextTrigger: string; lastTrigger: string; item: (page: number) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the accordion. Useful for composition.",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "Specifies the localized strings that identifies the accessibility elements and their states",
"tags": []
}
},
{
"name": "count",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Total number of data items",
"tags": []
}
},
{
"name": "pageSize",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled number of data items per page",
"tags": []
}
},
{
"name": "defaultPageSize",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial number of data items per page when rendered.\nUse when you don't need to control the page size of the pagination.",
"tags": [
{
"name": "default",
"value": "10"
}
]
}
},
{
"name": "siblingCount",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Number of pages to show beside active page",
"tags": [
{
"name": "default",
"value": "1"
}
]
}
},
{
"name": "boundaryCount",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Number of pages to show at the beginning and end",
"tags": [
{
"name": "default",
"value": "1"
}
]
}
},
{
"name": "page",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled active page",
"tags": []
}
},
{
"name": "defaultPage",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial active page when rendered.\nUse when you don't need to control the active page of the pagination.",
"tags": [
{
"name": "default",
"value": "1"
}
]
}
},
{
"name": "onPageChange",
"type": "((details: PageChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called when the page number is changed",
"tags": []
}
},
{
"name": "onPageSizeChange",
"type": "((details: PageSizeChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called when the page size is changed",
"tags": []
}
},
{
"name": "type",
"type": ""button" | "link" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The type of the trigger element",
"tags": [
{
"name": "default",
"value": ""button""
}
]
}
},
{
"name": "getPageUrl",
"type": "((details: PageUrlDetails) => string) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to generate href attributes for pagination links.\nOnly used when type is set to "link".",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"nav">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationRootProviderProps",
"props": [
{
"name": "value",
"type": "PaginationApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"nav">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationRootContextProps",
"props": [
{
"name": "children",
"type": "(pagination: PaginationApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "PaginationFirstTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationPrevTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationItemProps",
"props": [
{
"name": "type",
"type": ""page"",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "value",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"a">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationEllipsisProps",
"props": [
{
"name": "index",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationNextTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationLastTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "popover",
"types": [
{
"name": "PopoverRootProps",
"props": [
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "Specifies the localized strings that identifies the accessibility elements and their states",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ anchor: string; trigger: string | ((value?: string | undefined) => string); content: string; title: string; description: string; closeTrigger: string; positioner: string; arrow: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the popover. Useful for composition.",
"tags": []
}
},
{
"name": "modal",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the popover should be modal. When set to true:\n- interaction with outside elements will be disabled\n- only popover content will be visible to screen readers\n- scrolling is blocked\n- focus is trapped within the popover",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "portalled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the popover is portalled. This will proxy the tabbing behavior regardless of the DOM position\nof the popover content.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "autoFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to automatically set focus on the first focusable\ncontent within the popover when opened.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "initialFocusEl",
"type": "(() => HTMLElement | null) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The element to focus on when the popover is opened.",
"tags": []
}
},
{
"name": "finalFocusEl",
"type": "(() => MaybeElement) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Element to receive focus when the popover is closed.",
"tags": []
}
},
{
"name": "restoreFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to restore focus to the element that had focus before the popover was opened.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "closeOnInteractOutside",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the popover when the user clicks outside of the popover.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "closeOnEscape",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the popover when the escape key is pressed.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function invoked when the popover opens or closes",
"tags": []
}
},
{
"name": "positioning",
"type": "PositioningOptions | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The user provided options used to position the popover content",
"tags": []
}
},
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the popover",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the popover when rendered.\nUse when you don't need to control the open state of the popover.",
"tags": []
}
},
{
"name": "triggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled trigger value",
"tags": []
}
},
{
"name": "defaultTriggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial trigger value when rendered.\nUse when you don't need to control the trigger value.",
"tags": []
}
},
{
"name": "onTriggerValueChange",
"type": "((details: TriggerValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the trigger value changes.",
"tags": []
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "onEscapeKeyDown",
"type": "((event: KeyboardEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the escape key is pressed",
"tags": []
}
},
{
"name": "onRequestDismiss",
"type": "((event: LayerDismissEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when this layer is closed due to a parent layer being closed",
"tags": []
}
},
{
"name": "onPointerDownOutside",
"type": "((event: PointerDownOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the pointer is pressed down outside the component",
"tags": []
}
},
{
"name": "onFocusOutside",
"type": "((event: FocusOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the focus is moved outside the component",
"tags": []
}
},
{
"name": "onInteractOutside",
"type": "((event: InteractOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an interaction happens outside the component",
"tags": []
}
},
{
"name": "persistentElements",
"type": "(() => Element | null)[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "Returns the persistent elements that:\n- should not have pointer-events disabled\n- should not trigger the dismiss event",
"tags": []
}
}
]
},
{
"name": "PopoverRootProviderProps",
"props": [
{
"name": "value",
"type": "PopoverApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "PopoverRootContextProps",
"props": [
{
"name": "children",
"type": "(popover: PopoverApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "PopoverAnchorProps",
"props": [
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PopoverTriggerProps",
"props": [
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PopoverPositionerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PopoverContentProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PopoverArrowProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PopoverArrowTipProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PopoverTitleProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PopoverDescriptionProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PopoverCloseTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "portal",
"types": [
{
"name": "PortalRootProps",
"props": [
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "If true, the portal functionality is disabled and children are rendered in place.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "target",
"type": "HTMLElement | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The HTML element to which the portal content will be appended.",
"tags": [
{
"name": "default",
"value": "document.body"
}
]
}
},
{
"name": "children",
"type": "string | number | bigint | boolean | ReactElement> | Iterable | ReactPortal | Promise<...> | null",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
}
]
},
{
"name": "progress",
"types": [
{
"name": "ProgressRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; track: string; label: string; circle: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the progress bar. Useful for composition.",
"tags": []
}
},
{
"name": "value",
"type": "number | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled value of the progress bar.",
"tags": []
}
},
{
"name": "defaultValue",
"type": "number | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial value of the progress bar when rendered.\nUse when you don't need to control the value of the progress bar.",
"tags": [
{
"name": "default",
"value": "50"
}
]
}
},
{
"name": "min",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The minimum allowed value of the progress bar.",
"tags": [
{
"name": "default",
"value": "0"
}
]
}
},
{
"name": "max",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The maximum allowed value of the progress bar.",
"tags": [
{
"name": "default",
"value": "100"
}
]
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The localized messages to use.",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Callback fired when the value changes.",
"tags": []
}
},
{
"name": "formatOptions",
"type": "NumberFormatOptions | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The options to use for formatting the value.",
"tags": [
{
"name": "default",
"value": "{ style: "percent" }"
},
{
"name": "see",
"value": "://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat"
}
]
}
},
{
"name": "locale",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The locale to use for formatting the value.",
"tags": [
{
"name": "default",
"value": ""en-US""
}
]
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "orientation",
"type": ""horizontal" | "vertical" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The orientation of the element.",
"tags": [
{
"name": "default",
"value": ""horizontal""
}
]
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ProgressRootProviderProps",
"props": [
{
"name": "value",
"type": "ProgressApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ProgressRootContextProps",
"props": [
{
"name": "children",
"type": "(progress: ProgressApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "ProgressLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ProgressValueTextProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ProgressTrackProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ProgressRangeProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ProgressCircleProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"svg">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ProgressCircleTrackProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"circle">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ProgressCircleRangeProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"circle">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "qr-code",
"types": [
{
"name": "QrCodeRootProps",
"props": [
{
"name": "value",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled value to encode.",
"tags": []
}
},
{
"name": "defaultValue",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial value to encode when rendered.\nUse when you don't need to control the value of the qr code.",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ root: string; frame: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The element ids.",
"tags": []
}
},
{
"name": "encoding",
"type": "QrCodeGenerateOptions | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The qr code encoding options.",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Callback fired when the value changes.",
"tags": []
}
},
{
"name": "pixelSize",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The pixel size of the qr code.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "QrCodeRootProviderProps",
"props": [
{
"name": "value",
"type": "QrCodeApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "QrCodeRootContextProps",
"props": [
{
"name": "children",
"type": "(qrCode: QrCodeApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "QrCodeDownloadTriggerProps",
"props": [
{
"name": "mimeType",
"type": "DataUrlType",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The mime type of the image.",
"tags": []
}
},
{
"name": "quality",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The quality of the image.",
"tags": []
}
},
{
"name": "fileName",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The name of the file.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "QrCodeFrameProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"svg">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "QrCodePatternProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"path">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "QrCodeOverlayProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "rating-group",
"types": [
{
"name": "RatingGroupRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; label: string; hiddenInput: string; control: string; item: (id: string) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the rating. Useful for composition.",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "Specifies the localized strings that identifies the accessibility elements and their states",
"tags": []
}
},
{
"name": "count",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The total number of ratings.",
"tags": [
{
"name": "default",
"value": "5"
}
]
}
},
{
"name": "name",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The name attribute of the rating element (used in forms).",
"tags": []
}
},
{
"name": "form",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The associate form of the underlying input element.",
"tags": []
}
},
{
"name": "value",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled value of the rating",
"tags": []
}
},
{
"name": "defaultValue",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial value of the rating when rendered.\nUse when you don't need to control the value of the rating.",
"tags": []
}
},
{
"name": "readOnly",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the rating is readonly.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the rating is disabled.",
"tags": []
}
},
{
"name": "required",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the rating is required.",
"tags": []
}
},
{
"name": "allowHalf",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to allow half stars.",
"tags": []
}
},
{
"name": "autoFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to autofocus the rating.",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to be called when the rating value changes.",
"tags": []
}
},
{
"name": "onHoverChange",
"type": "((details: HoverChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to be called when the rating value is hovered.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "RatingGroupRootProviderProps",
"props": [
{
"name": "value",
"type": "RatingGroupApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "RatingGroupRootContextProps",
"props": [
{
"name": "children",
"type": "(ratingGroup: RatingGroupApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "RatingGroupLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"label">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "RatingGroupControlProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "RatingGroupItemProps",
"props": [
{
"name": "empty",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The content to render when the item is in the empty state.",
"tags": [
{
"name": "default",
"value": "StarEmpty (SVG)"
}
]
}
},
{
"name": "half",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The content to render when the item is in the half state.",
"tags": [
{
"name": "default",
"value": "StarHalf (SVG)"
}
]
}
},
{
"name": "full",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The content to render when the item is in the full state.",
"tags": [
{
"name": "default",
"value": "StarFull (SVG)"
}
]
}
},
{
"name": "index",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "RatingGroupHiddenInputProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"input">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "segmented-control",
"types": [
{
"name": "SegmentedControlRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; label: string; indicator: string; item: (value: string) => string; itemLabel: (value: string) => string; itemControl: (value: string) => string; itemHiddenInput: (value: string) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the radio. Useful for composition.",
"tags": []
}
},
{
"name": "value",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled value of the radio group",
"tags": []
}
},
{
"name": "defaultValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial value of the checked radio when rendered.\nUse when you don't need to control the value of the radio group.",
"tags": []
}
},
{
"name": "name",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The name of the input fields in the radio\n(Useful for form submission).",
"tags": []
}
},
{
"name": "form",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The associate form of the underlying input.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "If true, the radio group will be disabled",
"tags": []
}
},
{
"name": "invalid",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "If true, the radio group is marked as invalid.",
"tags": []
}
},
{
"name": "required",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "If true, the radio group is marked as required.",
"tags": []
}
},
{
"name": "readOnly",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the radio group is read-only",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called once a radio is checked",
"tags": []
}
},
{
"name": "orientation",
"type": ""horizontal" | "vertical" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Orientation of the radio group",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SegmentedControlRootProviderProps",
"props": [
{
"name": "value",
"type": "RadioGroupApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SegmentedControlRootContextProps",
"props": [
{
"name": "children",
"type": "(ratingGroup: RadioGroupApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "SegmentedControlLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SegmentedControlControlProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SegmentedControlIndicatorProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SegmentedControlItemProps",
"props": [
{
"name": "value",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "invalid",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"label">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SegmentedControlItemTextProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SegmentedControlItemHiddenInputProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"input">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "slider",
"types": [
{
"name": "SliderRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; thumb: (index: number) => string; hiddenInput: (index: number) => string; control: string; track: string; range: string; label: string; valueText: string; marker: (index: number) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the slider. Useful for composition.",
"tags": []
}
},
{
"name": "aria-label",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The aria-label of each slider thumb. Useful for providing an accessible name to the slider",
"tags": []
}
},
{
"name": "aria-labelledby",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The id of the elements that labels each slider thumb. Useful for providing an accessible name to the slider",
"tags": []
}
},
{
"name": "name",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The name associated with each slider thumb (when used in a form)",
"tags": []
}
},
{
"name": "form",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The associate form of the underlying input element.",
"tags": []
}
},
{
"name": "value",
"type": "number[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled value of the slider",
"tags": []
}
},
{
"name": "defaultValue",
"type": "number[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial value of the slider when rendered.\nUse when you don't need to control the value of the slider.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the slider is disabled",
"tags": []
}
},
{
"name": "readOnly",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the slider is read-only",
"tags": []
}
},
{
"name": "invalid",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the slider is invalid",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function invoked when the value of the slider changes",
"tags": []
}
},
{
"name": "onValueChangeEnd",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function invoked when the slider value change is done",
"tags": []
}
},
{
"name": "onFocusChange",
"type": "((details: FocusChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function invoked when the slider's focused index changes",
"tags": []
}
},
{
"name": "getAriaValueText",
"type": "((details: ValueTextDetails) => string) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function that returns a human readable value for the slider thumb",
"tags": []
}
},
{
"name": "min",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The minimum value of the slider",
"tags": [
{
"name": "default",
"value": "0"
}
]
}
},
{
"name": "max",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The maximum value of the slider",
"tags": [
{
"name": "default",
"value": "100"
}
]
}
},
{
"name": "step",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The step value of the slider",
"tags": [
{
"name": "default",
"value": "1"
}
]
}
},
{
"name": "minStepsBetweenThumbs",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The minimum permitted steps between multiple thumbs.\n\nminStepsBetweenThumbs * step should reflect the gap between the thumbs.\n\n- step: 1 and minStepsBetweenThumbs: 10 => gap is 10\n- step: 10 and minStepsBetweenThumbs: 2 => gap is 20",
"tags": [
{
"name": "default",
"value": "0"
}
]
}
},
{
"name": "orientation",
"type": ""vertical" | "horizontal" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The orientation of the slider",
"tags": [
{
"name": "default",
"value": ""horizontal""
}
]
}
},
{
"name": "origin",
"type": ""start" | "center" | "end" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The origin of the slider range. The track is filled from the origin\nto the thumb for single values.\n- "start": Useful when the value represents an absolute value\n- "center": Useful when the value represents an offset (relative)\n- "end": Useful when the value represents an offset from the end",
"tags": [
{
"name": "default",
"value": ""start""
}
]
}
},
{
"name": "thumbAlignment",
"type": ""center" | "contain" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The alignment of the slider thumb relative to the track\n- center: the thumb will extend beyond the bounds of the slider track.\n- contain: the thumb will be contained within the bounds of the track.",
"tags": [
{
"name": "default",
"value": ""contain""
}
]
}
},
{
"name": "thumbSize",
"type": "{ width: number; height: number; } | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The slider thumbs dimensions",
"tags": []
}
},
{
"name": "thumbCollisionBehavior",
"type": ""none" | "push" | "swap" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Controls how thumbs behave when they collide during pointer interactions.\n- none (default): Thumbs cannot move past each other; excess movement is ignored.\n- push: Thumbs push each other without restoring their previous positions when dragged back.\n- swap: Thumbs swap places when dragged past each other.",
"tags": [
{
"name": "default",
"value": ""none""
}
]
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SliderRootProviderProps",
"props": [
{
"name": "value",
"type": "SliderApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SliderRootContextProps",
"props": [
{
"name": "children",
"type": "(slider: SliderApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "SliderLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"label">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SliderValueTextProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"output">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SliderControlProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SliderTrackProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SliderRangeProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SliderThumbProps",
"props": [
{
"name": "index",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "name",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SliderHiddenInputProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"input">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SliderMarkerGroupProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SliderMarkerProps",
"props": [
{
"name": "value",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "steps",
"types": [
{
"name": "StepsRootProps",
"props": [
{
"name": "ids",
"type": "ElementIds | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The custom ids for the stepper elements",
"tags": []
}
},
{
"name": "step",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled value of the stepper",
"tags": []
}
},
{
"name": "defaultStep",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial value of the stepper when rendered.\nUse when you don't need to control the value of the stepper.",
"tags": []
}
},
{
"name": "onStepChange",
"type": "((details: StepChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Callback to be called when the value changes",
"tags": []
}
},
{
"name": "onStepComplete",
"type": "VoidFunction | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Callback to be called when a step is completed",
"tags": []
}
},
{
"name": "linear",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "If true, the stepper requires the user to complete the steps in order",
"tags": []
}
},
{
"name": "orientation",
"type": ""horizontal" | "vertical" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The orientation of the stepper",
"tags": [
{
"name": "default",
"value": ""horizontal""
}
]
}
},
{
"name": "count",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The total number of steps",
"tags": []
}
},
{
"name": "isStepValid",
"type": "((index: number) => boolean) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Whether a step is valid. Invalid steps block forward navigation in linear mode.",
"tags": [
{
"name": "default",
"value": "() => true"
}
]
}
},
{
"name": "isStepSkippable",
"type": "((index: number) => boolean) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Whether a step can be skipped during navigation.\nSkippable steps are bypassed when using next/prev.",
"tags": [
{
"name": "default",
"value": "() => false"
}
]
}
},
{
"name": "onStepInvalid",
"type": "((details: StepInvalidDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called when navigation is blocked due to an invalid step.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "StepsRootProviderProps",
"props": [
{
"name": "value",
"type": "StepsApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "StepsRootContextProps",
"props": [
{
"name": "children",
"type": "(steps: StepsApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "StepsListProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "StepsItemProps",
"props": [
{
"name": "index",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "StepsTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "StepsIndicatorProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "StepsSeparatorProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "StepsContentProps",
"props": [
{
"name": "index",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "StepsPrevTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "StepsNextTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "switch",
"types": [
{
"name": "SwitchRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; hiddenInput: string; control: string; label: string; thumb: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the switch. Useful for composition.",
"tags": []
}
},
{
"name": "label",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Specifies the localized strings that identifies the accessibility elements and their states",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the switch is disabled.",
"tags": []
}
},
{
"name": "invalid",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "If true, the switch is marked as invalid.",
"tags": []
}
},
{
"name": "required",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "If true, the switch input is marked as required,",
"tags": []
}
},
{
"name": "readOnly",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the switch is read-only",
"tags": []
}
},
{
"name": "onCheckedChange",
"type": "((details: CheckedChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to call when the switch is clicked.",
"tags": []
}
},
{
"name": "checked",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled checked state of the switch",
"tags": []
}
},
{
"name": "defaultChecked",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial checked state of the switch when rendered.\nUse when you don't need to control the checked state of the switch.",
"tags": []
}
},
{
"name": "name",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The name of the input field in a switch\n(Useful for form submission).",
"tags": []
}
},
{
"name": "form",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The id of the form that the switch belongs to",
"tags": []
}
},
{
"name": "value",
"type": "string | number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The value of switch input. Useful for form submission.",
"tags": [
{
"name": "default",
"value": ""on""
}
]
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"label">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SwitchRootProviderProps",
"props": [
{
"name": "value",
"type": "SwitchApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"label">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SwitchRootContextProps",
"props": [
{
"name": "children",
"type": "(switch_: SwitchApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "SwitchControlProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SwitchThumbProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SwitchLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "SwitchHiddenInputProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"input">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "tabs",
"types": [
{
"name": "TabsRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; trigger: (value: string) => string; list: string; content: (value: string) => string; indicator: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the tabs. Useful for composition.",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "Specifies the localized strings that identifies the accessibility elements and their states",
"tags": []
}
},
{
"name": "loopFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the keyboard navigation will loop from last tab to first, and vice versa.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "value",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled selected tab value",
"tags": []
}
},
{
"name": "defaultValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial selected tab value when rendered.\nUse when you don't need to control the selected tab value.",
"tags": []
}
},
{
"name": "orientation",
"type": ""horizontal" | "vertical" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The orientation of the tabs. Can be horizontal or vertical\n- horizontal: only left and right arrow key navigation will work.\n- vertical: only up and down arrow key navigation will work.",
"tags": [
{
"name": "default",
"value": ""horizontal""
}
]
}
},
{
"name": "activationMode",
"type": ""manual" | "automatic" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The activation mode of the tabs. Can be manual or automatic\n- manual: Tabs are activated when clicked or press enter key.\n- automatic: Tabs are activated when receiving focus",
"tags": [
{
"name": "default",
"value": ""automatic""
}
]
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Callback to be called when the selected/active tab changes",
"tags": []
}
},
{
"name": "onFocusChange",
"type": "((details: FocusChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Callback to be called when the focused tab changes",
"tags": []
}
},
{
"name": "composite",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the tab is composite",
"tags": []
}
},
{
"name": "deselectable",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the active tab can be deselected when clicking on it.",
"tags": []
}
},
{
"name": "navigate",
"type": "((details: NavigateDetails) => void) | null | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to navigate to the selected tab when clicking on it.\nUseful if tab triggers are anchor elements.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TabsRootProviderProps",
"props": [
{
"name": "value",
"type": "TabsApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TabsRootContextProps",
"props": [
{
"name": "children",
"type": "(tabs: TabsApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "TabsListProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TabsTriggerProps",
"props": [
{
"name": "value",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The value of the tab",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the tab is disabled",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TabsIndicatorProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TabsContentProps",
"props": [
{
"name": "value",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The value of the tab",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "tags-input",
"types": [
{
"name": "TagsInputRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; input: string; hiddenInput: string; clearBtn: string; label: string; control: string; item: (opts: ItemProps) => string; itemDeleteTrigger: (opts: ItemProps) => string; itemInput: (opts: ItemProps) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the tags input. Useful for composition.",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "Specifies the localized strings that identifies the accessibility elements and their states",
"tags": []
}
},
{
"name": "maxLength",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The max length of the input.",
"tags": []
}
},
{
"name": "delimiter",
"type": "string | RegExp | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The character that serves has:\n- event key to trigger the addition of a new tag\n- character used to split tags when pasting into the input",
"tags": [
{
"name": "default",
"value": "",""
}
]
}
},
{
"name": "autoFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the input should be auto-focused",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the tags input should be disabled",
"tags": []
}
},
{
"name": "readOnly",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the tags input should be read-only",
"tags": []
}
},
{
"name": "invalid",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the tags input is invalid",
"tags": []
}
},
{
"name": "required",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the tags input is required",
"tags": []
}
},
{
"name": "editable",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether a tag can be edited after creation, by pressing Enter or double clicking.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "inputValue",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled tag input's value",
"tags": []
}
},
{
"name": "defaultInputValue",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial tag input value when rendered.\nUse when you don't need to control the tag input value.",
"tags": []
}
},
{
"name": "value",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled tag value",
"tags": []
}
},
{
"name": "defaultValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial tag value when rendered.\nUse when you don't need to control the tag value.",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Callback fired when the tag values is updated",
"tags": []
}
},
{
"name": "onInputValueChange",
"type": "((details: InputValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Callback fired when the input value is updated",
"tags": []
}
},
{
"name": "onHighlightChange",
"type": "((details: HighlightChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Callback fired when a tag is highlighted by pointer or keyboard navigation",
"tags": []
}
},
{
"name": "onValueInvalid",
"type": "((details: ValidityChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Callback fired when the max tag count is reached or the validateTag function returns false",
"tags": []
}
},
{
"name": "validate",
"type": "((details: ValidateArgs) => boolean) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Returns a boolean that determines whether a tag can be added.\nUseful for preventing duplicates or invalid tag values.",
"tags": []
}
},
{
"name": "allowDuplicates",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to allow duplicate tags.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "blurBehavior",
"type": ""clear" | "add" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The behavior of the tags input when the input is blurred\n- \"add\": add the input value as a new tag\n- \"clear\": clear the input value",
"tags": []
}
},
{
"name": "addOnPaste",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to add a tag when you paste values into the tag input",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "max",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The max number of tags",
"tags": [
{
"name": "default",
"value": "Infinity"
}
]
}
},
{
"name": "allowOverflow",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to allow tags to exceed max. In this case,\nwe'll attach data-invalid to the root",
"tags": []
}
},
{
"name": "sanitizeValue",
"type": "((value: string) => string) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to sanitize the tag value before adding.\nUseful for trimming whitespace, normalizing case, or stripping special characters.",
"tags": [
{
"name": "default",
"value": "(value) => value.trim()"
},
{
"name": "example",
"value": "(value) => value.toLowerCase().trim()"
}
]
}
},
{
"name": "name",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The name attribute for the input. Useful for form submissions",
"tags": []
}
},
{
"name": "form",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The associate form of the underlying input element.",
"tags": []
}
},
{
"name": "placeholder",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The placeholder text for the input",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "onPointerDownOutside",
"type": "((event: PointerDownOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the pointer is pressed down outside the component",
"tags": []
}
},
{
"name": "onFocusOutside",
"type": "((event: FocusOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the focus is moved outside the component",
"tags": []
}
},
{
"name": "onInteractOutside",
"type": "((event: InteractOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an interaction happens outside the component",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TagsInputRootProviderProps",
"props": [
{
"name": "value",
"type": "TagsInputApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TagsInputRootContextProps",
"props": [
{
"name": "children",
"type": "(tagsInput: TagsInputApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "TagsInputLabelProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"label">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TagsInputControlProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TagsInputItemProps",
"props": [
{
"name": "index",
"type": "string | number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "value",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TagsInputItemPreviewProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TagsInputItemTextProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TagsInputItemDeleteTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TagsInputItemInputProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"input">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TagsInputInputProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"input">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TagsInputClearTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TagsInputHiddenInputProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"input">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "toast",
"types": [
{
"name": "ToastRootProps",
"props": [
{
"name": "toast",
"type": "Omit<ToastOptions, "id" | "parent">",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "index",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ToastRootContextProps",
"props": [
{
"name": "children",
"type": "(toast: ToastApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "ToastGroupProps",
"props": [
{
"name": "toaster",
"type": "ToastStore",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "children",
"type": "((toast: ToastProps) => Element | null) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ToastMessageProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ToastTitleProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ToastDescriptionProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ToastActionTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ToastCloseTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "toggle-group",
"types": [
{
"name": "ToggleGroupRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; item: (value: string) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the toggle. Useful for composition.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the toggle is disabled.",
"tags": []
}
},
{
"name": "value",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled selected value of the toggle group.",
"tags": []
}
},
{
"name": "defaultValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial selected value of the toggle group when rendered.\nUse when you don't need to control the selected value of the toggle group.",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to call when the toggle is clicked.",
"tags": []
}
},
{
"name": "loopFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to loop focus inside the toggle group.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "rovingFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to use roving tab index to manage focus.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "orientation",
"type": "Orientation | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The orientation of the toggle group.",
"tags": [
{
"name": "default",
"value": ""horizontal""
}
]
}
},
{
"name": "multiple",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to allow multiple toggles to be selected.",
"tags": []
}
},
{
"name": "deselectable",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the toggle group allows empty selection.\nNote: This is ignored if multiple is true.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ToggleGroupRootProviderProps",
"props": [
{
"name": "value",
"type": "ToggleGroupApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ToggleGroupRootContextProps",
"props": [
{
"name": "children",
"type": "(togglegroup: ToggleGroupApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "ToggleGroupItemProps",
"props": [
{
"name": "value",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "tooltip",
"types": [
{
"name": "TooltipRootProps",
"props": [
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ trigger: string | ((value?: string | undefined) => string); content: string; arrow: string; positioner: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the tooltip. Useful for composition.",
"tags": []
}
},
{
"name": "openDelay",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The open delay of the tooltip.",
"tags": [
{
"name": "default",
"value": "400"
}
]
}
},
{
"name": "closeDelay",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The close delay of the tooltip.",
"tags": [
{
"name": "default",
"value": "150"
}
]
}
},
{
"name": "closeOnPointerDown",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the tooltip on pointerdown.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "closeOnEscape",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the tooltip when the Escape key is pressed.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "closeOnScroll",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the tooltip should close on scroll",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "closeOnClick",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the tooltip should close on click",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "interactive",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the tooltip's content is interactive.\nIn this mode, the tooltip will remain open when user hovers over the content.",
"tags": [
{
"name": "see",
"value": "://www.w3.org/TR/WCAG21/#content-on-hover-or-focus"
},
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the tooltip is opened.",
"tags": []
}
},
{
"name": "aria-label",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Custom label for the tooltip.",
"tags": []
}
},
{
"name": "positioning",
"type": "PositioningOptions | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The user provided options used to position the popover content",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the tooltip is disabled",
"tags": []
}
},
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the tooltip",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the tooltip when rendered.\nUse when you don't need to control the open state of the tooltip.",
"tags": []
}
},
{
"name": "triggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled trigger value",
"tags": []
}
},
{
"name": "defaultTriggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial trigger value when rendered.\nUse when you don't need to control the trigger value.",
"tags": []
}
},
{
"name": "onTriggerValueChange",
"type": "((details: TriggerValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the trigger value changes.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
}
]
},
{
"name": "TooltipRootProviderProps",
"props": [
{
"name": "value",
"type": "TooltipApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "TooltipRootContextProps",
"props": [
{
"name": "children",
"type": "(tooltip: TooltipApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "TooltipTriggerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"button">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TooltipPositionerProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TooltipContentProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TooltipArrowProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TooltipArrowTipProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "tree-view",
"types": [
{
"name": "TreeViewNodeContextProps",
"props": [
{
"name": "children",
"type": "(treeView: NodeProps) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "TreeViewRootProps",
"props": [
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "Specifies the localized strings that identifies the accessibility elements and their states",
"tags": []
}
},
{
"name": "collection",
"type": "TreeCollection | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The tree collection data",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ root: string; tree: string; label: string; node: (value: string) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the tree elements. Useful for composition.",
"tags": []
}
},
{
"name": "expandedValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled expanded node ids",
"tags": []
}
},
{
"name": "defaultExpandedValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial expanded node ids when rendered.\nUse when you don't need to control the expanded node value.",
"tags": []
}
},
{
"name": "selectedValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled selected node value",
"tags": []
}
},
{
"name": "defaultSelectedValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial selected node value when rendered.\nUse when you don't need to control the selected node value.",
"tags": []
}
},
{
"name": "defaultCheckedValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial checked node value when rendered.\nUse when you don't need to control the checked node value.",
"tags": []
}
},
{
"name": "checkedValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled checked node value",
"tags": []
}
},
{
"name": "defaultFocusedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial focused node value when rendered.\nUse when you don't need to control the focused node value.",
"tags": []
}
},
{
"name": "focusedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The value of the focused node",
"tags": []
}
},
{
"name": "selectionMode",
"type": ""single" | "multiple" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the tree supports multiple selection\n- "single": only one node can be selected\n- "multiple": multiple nodes can be selected",
"tags": [
{
"name": "default",
"value": ""single""
}
]
}
},
{
"name": "onExpandedChange",
"type": "((details: ExpandedChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called when the tree is opened or closed",
"tags": []
}
},
{
"name": "onSelectionChange",
"type": "((details: SelectionChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called when the selection changes",
"tags": []
}
},
{
"name": "onFocusChange",
"type": "((details: FocusChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called when the focused node changes",
"tags": []
}
},
{
"name": "onCheckedChange",
"type": "((details: CheckedChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called when the checked value changes",
"tags": []
}
},
{
"name": "canRename",
"type": "((node: T, indexPath: IndexPath) => boolean) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to determine if a node can be renamed",
"tags": []
}
},
{
"name": "onRenameStart",
"type": "((details: RenameStartDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called when a node starts being renamed",
"tags": []
}
},
{
"name": "onBeforeRename",
"type": "((details: RenameCompleteDetails) => boolean) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called before a rename is completed. Return false to prevent the rename.",
"tags": []
}
},
{
"name": "onRenameComplete",
"type": "((details: RenameCompleteDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called when a node label rename is completed",
"tags": []
}
},
{
"name": "onLoadChildrenComplete",
"type": "((details: LoadChildrenCompleteDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called when a node finishes loading children",
"tags": []
}
},
{
"name": "onLoadChildrenError",
"type": "((details: LoadChildrenErrorDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called when loading children fails for one or more nodes",
"tags": []
}
},
{
"name": "expandOnClick",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether clicking on a branch should open it or not",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "typeahead",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the tree supports typeahead search",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "loadChildren",
"type": "((details: LoadChildrenDetails) => Promise<T[]>) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to load children for a node asynchronously.\nWhen provided, branches will wait for this promise to resolve before expanding.",
"tags": []
}
},
{
"name": "scrollToIndexFn",
"type": "((details: ScrollToIndexDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to scroll to a specific index.\nUseful for virtualized tree views.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TreeViewRootProviderProps",
"props": [
{
"name": "value",
"type": "TreeViewApi",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TreeViewRootContextProps",
"props": [
{
"name": "children",
"type": "(treeView: TreeViewApi) => ReactNode",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "TreeViewTreeProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TreeViewLabelProps",
"props": [
{
"name": "level",
"type": "1 | 2 | 3 | 4 | 5 | 6 | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The level of the heading.",
"tags": [
{
"name": "defaultValue",
"value": "3"
}
]
}
},
{
"name": "element",
"type": "((attributes: HTMLAttributes<"h3">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TreeViewNodeProviderProps",
"props": [
{
"name": "value",
"type": "NodeProps",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "children",
"type": "ReactNode",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "TreeViewBranchProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TreeViewBranchControlProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TreeViewBranchTextProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TreeViewBranchIndicatorProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"span">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TreeViewBranchContentProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TreeViewBranchIndentGuideProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "TreeViewItemProps",
"props": [
{
"name": "element",
"type": "((attributes: HTMLAttributes<"div">) => Element) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
}
]
},
{
"framework": "svelte",
"components": [
{
"name": "accordion",
"types": [
{
"name": "AccordionRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; item: (value: string) => string; itemContent: (value: string) => string; itemTrigger: (value: string) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the accordion. Useful for composition.",
"tags": []
}
},
{
"name": "multiple",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether multiple accordion items can be expanded at the same time.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "collapsible",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether an accordion item can be closed after it has been expanded.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "value",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled value of the expanded accordion items.",
"tags": []
}
},
{
"name": "defaultValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial value of the expanded accordion items.\nUse when you don't need to control the value of the accordion.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the accordion items are disabled",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The callback fired when the state of expanded/collapsed accordion items changes.",
"tags": []
}
},
{
"name": "onFocusChange",
"type": "((details: FocusChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The callback fired when the focused accordion item changes.",
"tags": []
}
},
{
"name": "orientation",
"type": ""horizontal" | "vertical" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The orientation of the accordion items.",
"tags": [
{
"name": "default",
"value": ""vertical""
}
]
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AccordionRootProviderProps",
"props": [
{
"name": "value",
"type": "() => AccordionApi",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AccordionRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[() => AccordionApi]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "AccordionItemProps",
"props": [
{
"name": "value",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The value of the accordion item.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the accordion item is disabled.",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AccordionItemTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AccordionItemIndicatorProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AccordionItemContentProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "app-bar",
"types": [
{
"name": "AppBarRootProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"header">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AppBarToolbarProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AppBarLeadProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"nav">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AppBarHeadlineProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AppBarTrailProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"nav">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "avatar",
"types": [
{
"name": "AvatarRootProps",
"props": [
{
"name": "onStatusChange",
"type": "((details: StatusChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Functional called when the image loading status changes.",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ root: string; image: string; fallback: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the avatar. Useful for composition.",
"tags": []
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AvatarRootProviderProps",
"props": [
{
"name": "value",
"type": "() => AvatarApi",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AvatarRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[() => AvatarApi]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "AvatarImageProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"img">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "AvatarFallbackProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"span">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "carousel",
"types": [
{
"name": "CarouselRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; item: (index: number) => string; itemGroup: string; nextTrigger: string; prevTrigger: string; indicatorGroup: string; indicator: (index: number) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the carousel. Useful for composition.",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The localized messages to use.",
"tags": []
}
},
{
"name": "slidesPerPage",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The number of slides to show at a time.",
"tags": [
{
"name": "default",
"value": "1"
}
]
}
},
{
"name": "autoSize",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to enable variable width slides.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "slidesPerMove",
"type": "number | "auto" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The number of slides to scroll at a time.\n\nWhen set to auto, the number of slides to scroll is determined by the\nslidesPerPage property.",
"tags": [
{
"name": "default",
"value": ""auto""
}
]
}
},
{
"name": "autoplay",
"type": "boolean | { delay: number; } | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "Whether to scroll automatically. The default delay is 4000ms.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "allowMouseDrag",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to allow scrolling via dragging with mouse",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "loop",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the carousel should loop around.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "page",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled page of the carousel.",
"tags": []
}
},
{
"name": "defaultPage",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial page to scroll to when rendered.\nUse when you don't need to control the page of the carousel.",
"tags": [
{
"name": "default",
"value": "0"
}
]
}
},
{
"name": "spacing",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The amount of space between items.",
"tags": [
{
"name": "default",
"value": ""0px""
}
]
}
},
{
"name": "padding",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Defines the extra space added around the scrollable area,\nenabling nearby items to remain partially in view.",
"tags": []
}
},
{
"name": "onPageChange",
"type": "((details: PageChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the page changes.",
"tags": []
}
},
{
"name": "inViewThreshold",
"type": "number | number[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The threshold for determining if an item is in view.",
"tags": [
{
"name": "default",
"value": "0.6"
}
]
}
},
{
"name": "snapType",
"type": ""proximity" | "mandatory" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The snap type of the item.",
"tags": [
{
"name": "default",
"value": ""mandatory""
}
]
}
},
{
"name": "slideCount",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The total number of slides.\nUseful for SSR to render the initial ating the snap points.",
"tags": []
}
},
{
"name": "onDragStatusChange",
"type": "((details: DragStatusDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the drag status changes.",
"tags": []
}
},
{
"name": "onAutoplayStatusChange",
"type": "((details: AutoplayStatusDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the autoplay status changes.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "orientation",
"type": ""horizontal" | "vertical" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The orientation of the element.",
"tags": [
{
"name": "default",
"value": ""horizontal""
}
]
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselRootProviderProps",
"props": [
{
"name": "value",
"type": "() => CarouselApi",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[() => CarouselApi]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "CarouselControlProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselItemGroupProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselItemProps",
"props": [
{
"name": "index",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The index of the item.",
"tags": []
}
},
{
"name": "snapAlign",
"type": ""start" | "end" | "center" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The snap alignment of the item.",
"tags": [
{
"name": "default",
"value": ""start""
}
]
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselPrevTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselNextTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselAutoplayTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselIndicatorGroupProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselIndicatorProps",
"props": [
{
"name": "index",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The index of the indicator.",
"tags": []
}
},
{
"name": "readOnly",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the indicator is read only.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CarouselProgressTextProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "collapsible",
"types": [
{
"name": "CollapsibleRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; content: string; trigger: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the collapsible. Useful for composition.",
"tags": []
}
},
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the collapsible.",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the collapsible when rendered.\nUse when you don't need to control the open state of the collapsible.",
"tags": []
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The callback invoked when the open state changes.",
"tags": []
}
},
{
"name": "onExitComplete",
"type": "VoidFunction | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The callback invoked when the exit animation completes.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the collapsible is disabled.",
"tags": []
}
},
{
"name": "collapsedHeight",
"type": "string | number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The height of the content when collapsed.",
"tags": []
}
},
{
"name": "collapsedWidth",
"type": "string | number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The width of the content when collapsed.",
"tags": []
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CollapsibleRootProviderProps",
"props": [
{
"name": "value",
"type": "() => CollapsibleApi",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CollapsibleRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[() => CollapsibleApi]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "CollapsibleTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CollapsibleIndicatorProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "CollapsibleContentProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "combobox",
"types": [
{
"name": "ComboboxRootProps",
"props": [
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the combobox",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the combobox when rendered.\nUse when you don't need to control the open state of the combobox.",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ root: string; label: string; control: string; input: string; content: string; trigger: string; clearTrigger: string; item: (id: string, index?: number | undefined) => string; positioner: string; itemGroup: (id: string | number) => string; itemGroupLabel: (id: string | number) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the combobox. Useful for composition.",
"tags": []
}
},
{
"name": "inputValue",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled value of the combobox's input",
"tags": []
}
},
{
"name": "defaultInputValue",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial value of the combobox's input when rendered.\nUse when you don't need to control the value of the combobox's input.",
"tags": [
{
"name": "default",
"value": """"
}
]
}
},
{
"name": "name",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The name attribute of the combobox's input. Useful for form submission",
"tags": []
}
},
{
"name": "form",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The associate form of the combobox.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the combobox is disabled",
"tags": []
}
},
{
"name": "readOnly",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the combobox is readonly. This puts the combobox in a "non-editable" mode\nbut the user can still interact with it",
"tags": []
}
},
{
"name": "invalid",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the combobox is invalid",
"tags": []
}
},
{
"name": "required",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the combobox is required",
"tags": []
}
},
{
"name": "placeholder",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The placeholder text of the combobox's input",
"tags": []
}
},
{
"name": "defaultHighlightedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial highlighted value of the combobox when rendered.\nUse when you don't need to control the highlighted value of the combobox.",
"tags": []
}
},
{
"name": "highlightedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled highlighted value of the combobox",
"tags": []
}
},
{
"name": "value",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled value of the combobox's selected items",
"tags": []
}
},
{
"name": "defaultValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial value of the combobox's selected items when rendered.\nUse when you don't need to control the value of the combobox's selected items.",
"tags": [
{
"name": "default",
"value": "[]"
}
]
}
},
{
"name": "inputBehavior",
"type": ""autohighlight" | "autocomplete" | "none" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Defines the auto-completion behavior of the combobox.\n\n- autohighlight: The first focused item is highlighted as the user types\n- autocomplete: Navigating the listbox with the arrow keys selects the item and the input is updated",
"tags": [
{
"name": "default",
"value": ""none""
}
]
}
},
{
"name": "selectionBehavior",
"type": ""clear" | "replace" | "preserve" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The behavior of the combobox input when an item is selected\n\n- replace: The selected item string is set as the input value\n- clear: The input value is cleared\n- preserve: The input value is preserved",
"tags": [
{
"name": "default",
"value": ""replace""
}
]
}
},
{
"name": "autoFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to autofocus the input on mount",
"tags": []
}
},
{
"name": "openOnClick",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to open the combobox popup on initial click on the input",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "openOnChange",
"type": "boolean | ((details: InputValueChangeDetails) => boolean) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Whether to show the combobox when the input value changes",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "allowCustomValue",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to allow typing custom values in the input",
"tags": []
}
},
{
"name": "alwaysSubmitOnEnter",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to always submit on Enter key press, even if popup is open.\nUseful for single-field autocomplete forms where Enter should submit the form.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "loopFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to loop the keyboard navigation through the items",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "positioning",
"type": "PositioningOptions | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The positioning options to dynamically position the menu",
"tags": [
{
"name": "default",
"value": "{ placement: "bottom-start" }"
}
]
}
},
{
"name": "onInputValueChange",
"type": "((details: InputValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the input's value changes",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when a new item is selected",
"tags": []
}
},
{
"name": "onHighlightChange",
"type": "((details: HighlightChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an item is highlighted using the pointer\nor keyboard navigation.",
"tags": []
}
},
{
"name": "onSelect",
"type": "((details: SelectionDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an item is selected",
"tags": []
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the popup is opened",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "Specifies the localized strings that identifies the accessibility elements and their states",
"tags": []
}
},
{
"name": "collection",
"type": "ListCollection | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The collection of items",
"tags": []
}
},
{
"name": "multiple",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to allow multiple selection.\n\nGood to know: When multiple is true, the selectionBehavior is automatically set to clear.\nIt is recommended to render the selected items in a separate container.",
"tags": []
}
},
{
"name": "closeOnSelect",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the combobox when an item is selected.",
"tags": []
}
},
{
"name": "openOnKeyPress",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to open the combobox on arrow key press",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "scrollToIndexFn",
"type": "((details: ScrollToIndexDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to scroll to a specific index",
"tags": []
}
},
{
"name": "composite",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the combobox is a composed with other composite widgets like tabs",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "disableLayer",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to disable registering this a dismissable layer",
"tags": []
}
},
{
"name": "navigate",
"type": "((details: NavigateDetails) => void) | null | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to navigate to the selected item",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "onPointerDownOutside",
"type": "((event: PointerDownOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the pointer is pressed down outside the component",
"tags": []
}
},
{
"name": "onFocusOutside",
"type": "((event: FocusOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the focus is moved outside the component",
"tags": []
}
},
{
"name": "onInteractOutside",
"type": "((event: InteractOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an interaction happens outside the component",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxRootProviderProps",
"props": [
{
"name": "value",
"type": "() => ComboboxApi",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[() => ComboboxApi]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "ComboboxLabelProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"label">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxControlProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxInputProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"input">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxClearTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxPositionerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxContentProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"ul">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxItemGroupProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxItemGroupLabelProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxItemProps",
"props": [
{
"name": "persistFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether hovering outside should clear the highlighted state",
"tags": []
}
},
{
"name": "item",
"type": "any",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The item to render",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"li">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxItemTextProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"span">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ComboboxItemIndicatorProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "date-picker",
"types": [
{
"name": "DatePickerRootProps",
"props": [
{
"name": "locale",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The locale (BCP 47 language tag) to use when formatting the date.",
"tags": [
{
"name": "default",
"value": ""en-US""
}
]
}
},
{
"name": "createCalendar",
"type": "((identifier: CalendarIdentifier) => Calendar) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A function that creates a Calendar object for a given calendar identifier.\nEnables non-Gregorian calendar support (Persian, Buddhist, Islamic, etc.)\nwithout bundling all calendars by default.",
"tags": [
{
"name": "example",
"value": "import { createCalendar } from "@internationalized/date"\n{ locale: "fa-IR", createCalendar }"
}
]
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The localized messages to use.",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ root: string; label: (index: number) => string; table: (id: string) => string; tableHeader: (id: string) => string; tableBody: (id: string) => string; tableRow: (id: string) => string; ... 11 more ...; positioner: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the date picker. Useful for composition.",
"tags": []
}
},
{
"name": "name",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The name attribute of the input element.",
"tags": []
}
},
{
"name": "timeZone",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The time zone to use",
"tags": [
{
"name": "default",
"value": ""UTC""
}
]
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the calendar is disabled.",
"tags": []
}
},
{
"name": "readOnly",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the calendar is read-only.",
"tags": []
}
},
{
"name": "required",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the date picker is required",
"tags": []
}
},
{
"name": "invalid",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the date picker is invalid",
"tags": []
}
},
{
"name": "outsideDaySelectable",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether day outside the visible range can be selected.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "min",
"type": "DateValue | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The minimum date that can be selected.",
"tags": []
}
},
{
"name": "max",
"type": "DateValue | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The maximum date that can be selected.",
"tags": []
}
},
{
"name": "closeOnSelect",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the calendar should close after the date selection is complete.\nThis is ignored when the selection mode is multiple.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "openOnClick",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to open the calendar when the input is clicked.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "value",
"type": "DateValue[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled selected date(s).",
"tags": []
}
},
{
"name": "defaultValue",
"type": "DateValue[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial selected date(s) when rendered.\nUse when you don't need to control the selected date(s) of the date picker.",
"tags": []
}
},
{
"name": "focusedValue",
"type": "DateValue | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The controlled focused date.",
"tags": []
}
},
{
"name": "defaultFocusedValue",
"type": "DateValue | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The initial focused date when rendered.\nUse when you don't need to control the focused date of the date picker.",
"tags": []
}
},
{
"name": "numOfMonths",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The number of months to display.",
"tags": []
}
},
{
"name": "startOfWeek",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The first day of the week.\n 0 - Sunday\n 1 - Monday\n 2 - Tuesday\n 3 - Wednesday\n 4 - Thursday\n 5 - Friday\n 6 - Saturday",
"tags": []
}
},
{
"name": "fixedWeeks",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the calendar should have a fixed number of weeks.\nThis renders the calendar with 6 weeks instead of 5 or 6.",
"tags": []
}
},
{
"name": "showWeekNumbers",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to show the week number column in the day view.",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the value changes.",
"tags": []
}
},
{
"name": "onFocusChange",
"type": "((details: FocusChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the focused date changes.",
"tags": []
}
},
{
"name": "onViewChange",
"type": "((details: ViewChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the view changes.",
"tags": []
}
},
{
"name": "onVisibleRangeChange",
"type": "((details: VisibleRangeChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the visible range changes.",
"tags": []
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the calendar opens or closes.",
"tags": []
}
},
{
"name": "isDateUnavailable",
"type": "((date: DateValue, locale: string) => boolean) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Returns whether a date of the calendar is available.",
"tags": []
}
},
{
"name": "selectionMode",
"type": "SelectionMode | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The selection mode of the calendar.\n- single - only one date can be selected\n- multiple - multiple dates can be selected\n- range - a range of dates can be selected",
"tags": [
{
"name": "default",
"value": ""single""
}
]
}
},
{
"name": "maxSelectedDates",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The maximum number of dates that can be selected.\nThis is only applicable when selectionMode is multiple.",
"tags": []
}
},
{
"name": "format",
"type": "((date: DateValue, details: LocaleDetails) => string) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The format of the date to display in the input.",
"tags": []
}
},
{
"name": "parse",
"type": "((value: string, details: LocaleDetails) => DateValue | undefined) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to parse the date from the input back to a DateValue.",
"tags": []
}
},
{
"name": "placeholder",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The placeholder text to display in the input.",
"tags": []
}
},
{
"name": "view",
"type": "DateView | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The view of the calendar",
"tags": []
}
},
{
"name": "defaultView",
"type": "DateView | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The default view of the calendar",
"tags": [
{
"name": "default",
"value": ""day""
}
]
}
},
{
"name": "minView",
"type": "DateView | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The minimum view of the calendar",
"tags": [
{
"name": "default",
"value": ""day""
}
]
}
},
{
"name": "maxView",
"type": "DateView | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The maximum view of the calendar",
"tags": [
{
"name": "default",
"value": ""year""
}
]
}
},
{
"name": "positioning",
"type": "PositioningOptions | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The user provided options used to position the date picker content",
"tags": []
}
},
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the date picker",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the date picker when rendered.\nUse when you don't need to control the open state of the date picker.",
"tags": []
}
},
{
"name": "inline",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to render the date picker inline",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerRootProviderProps",
"props": [
{
"name": "value",
"type": "() => DatePickerApi",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[() => DatePickerApi]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "DatePickerLabelProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"label">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerControlProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerPresetTriggerProps",
"props": [
{
"name": "value",
"type": "PresetTriggerValue",
"typeKind": "array",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerInputProps",
"props": [
{
"name": "index",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The index of the input to focus.",
"tags": []
}
},
{
"name": "fixOnBlur",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to fix the input value on blur.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"input">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerPositionerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerContentProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerYearSelectProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"select">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerMonthSelectProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"select">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerViewProps",
"props": [
{
"name": "view",
"type": "DateView | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerViewControlProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerPrevTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerViewTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerRangeTextProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerNextTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"table">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableHeadProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"thead">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableRowProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"tr">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableHeaderProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"th">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableBodyProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"tbody">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableCellProps",
"props": [
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "value",
"type": "number | DateValue",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "columns",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "visibleRange",
"type": "VisibleRange | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"td">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DatePickerTableCellTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "dialog",
"types": [
{
"name": "DialogRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ trigger: string | ((value?: string | undefined) => string); positioner: string; backdrop: string; content: string; closeTrigger: string; title: string; description: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the dialog. Useful for composition.",
"tags": []
}
},
{
"name": "trapFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to trap focus inside the dialog when it's opened",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "preventScroll",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to prevent scrolling behind the dialog when it's opened",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "modal",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to prevent pointer interaction outside the element and hide all content below it",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "initialFocusEl",
"type": "(() => MaybeElement) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Element to receive focus when the dialog is opened",
"tags": []
}
},
{
"name": "finalFocusEl",
"type": "(() => MaybeElement) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Element to receive focus when the dialog is closed",
"tags": []
}
},
{
"name": "restoreFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to restore focus to the element that had focus before the dialog was opened",
"tags": []
}
},
{
"name": "closeOnInteractOutside",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the dialog when the outside is clicked",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "closeOnEscape",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the dialog when the escape key is pressed",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "aria-label",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Human readable label for the dialog, in event the dialog title is not rendered",
"tags": []
}
},
{
"name": "role",
"type": ""dialog" | "alertdialog" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The dialog's role",
"tags": [
{
"name": "default",
"value": ""dialog""
}
]
}
},
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the dialog",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the dialog when rendered.\nUse when you don't need to control the open state of the dialog.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to call when the dialog's open state changes",
"tags": []
}
},
{
"name": "triggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled active trigger value",
"tags": []
}
},
{
"name": "defaultTriggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial active trigger value when rendered.\nUse when you don't need to control the active trigger value.",
"tags": []
}
},
{
"name": "onTriggerValueChange",
"type": "((details: TriggerValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to call when the active trigger changes",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "onEscapeKeyDown",
"type": "((event: KeyboardEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the escape key is pressed",
"tags": []
}
},
{
"name": "onRequestDismiss",
"type": "((event: LayerDismissEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when this layer is closed due to a parent layer being closed",
"tags": []
}
},
{
"name": "onPointerDownOutside",
"type": "((event: PointerDownOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the pointer is pressed down outside the component",
"tags": []
}
},
{
"name": "onFocusOutside",
"type": "((event: FocusOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the focus is moved outside the component",
"tags": []
}
},
{
"name": "onInteractOutside",
"type": "((event: InteractOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an interaction happens outside the component",
"tags": []
}
},
{
"name": "persistentElements",
"type": "(() => Element | null)[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "Returns the persistent elements that:\n- should not have pointer-events disabled\n- should not trigger the dismiss event",
"tags": []
}
},
{
"name": "children",
"type": "Snippet<[]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The default slot content to be rendered within the component.",
"tags": []
}
}
]
},
{
"name": "DialogRootProviderProps",
"props": [
{
"name": "value",
"type": "() => DialogApi",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "children",
"type": "Snippet<[]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The default slot content to be rendered within the component.",
"tags": []
}
}
]
},
{
"name": "DialogRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[() => DialogApi]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "DialogTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DialogBackdropProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DialogPositionerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DialogContentProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DialogTitleProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DialogDescriptionProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "DialogCloseTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "file-upload",
"types": [
{
"name": "FileUploadRootProps",
"props": [
{
"name": "name",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The name of the underlying file input",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ root: string; dropzone: string; hiddenInput: string; trigger: string; label: string; item: (id: string) => string; itemName: (id: string) => string; itemSizeText: (id: string) => string; itemPreview: (id: string) => string; itemDeleteTrigger: (id: string) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements. Useful for composition.",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The localized messages to use.",
"tags": []
}
},
{
"name": "accept",
"type": "Record<string, string[]> | FileMimeType | FileMimeType[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The accept file types",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the file input is disabled",
"tags": []
}
},
{
"name": "required",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the file input is required",
"tags": []
}
},
{
"name": "allowDrop",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to allow drag and drop in the dropzone element",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "maxFileSize",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The maximum file size in bytes",
"tags": [
{
"name": "default",
"value": "Infinity"
}
]
}
},
{
"name": "minFileSize",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The minimum file size in bytes",
"tags": [
{
"name": "default",
"value": "0"
}
]
}
},
{
"name": "maxFiles",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The maximum number of files",
"tags": [
{
"name": "default",
"value": "1"
}
]
}
},
{
"name": "preventDocumentDrop",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to prevent the drop event on the document",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "validate",
"type": "((file: File, details: FileValidateDetails) => FileError[] | null) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to validate a file",
"tags": []
}
},
{
"name": "defaultAcceptedFiles",
"type": "File[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The default accepted files when rendered.\nUse when you don't need to control the accepted files of the input.",
"tags": []
}
},
{
"name": "acceptedFiles",
"type": "File[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled accepted files",
"tags": []
}
},
{
"name": "onFileChange",
"type": "((details: FileChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the value changes, whether accepted or rejected",
"tags": []
}
},
{
"name": "onFileAccept",
"type": "((details: FileAcceptDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the file is accepted",
"tags": []
}
},
{
"name": "onFileReject",
"type": "((details: FileRejectDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the file is rejected",
"tags": []
}
},
{
"name": "capture",
"type": ""user" | "environment" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The default camera to use when capturing media",
"tags": []
}
},
{
"name": "directory",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to accept directories, only works in webkit browsers",
"tags": []
}
},
{
"name": "invalid",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the file input is invalid",
"tags": []
}
},
{
"name": "readOnly",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the file input is read-only",
"tags": []
}
},
{
"name": "transformFiles",
"type": "((files: File[]) => Promise<File[]>) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to transform the accepted files to apply transformations",
"tags": []
}
},
{
"name": "locale",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The current locale. Based on the BCP 47 definition.",
"tags": [
{
"name": "default",
"value": ""en-US""
}
]
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadRootProviderProps",
"props": [
{
"name": "value",
"type": "() => FileUploadApi",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[any]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "FileUploadLabelProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"label">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadDropzoneProps",
"props": [
{
"name": "disableClick",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to disable the click event on the dropzone",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadClearTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadHiddenInputProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"input">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadItemGroupProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"ul">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadItemProps",
"props": [
{
"name": "file",
"type": "File",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "type",
"type": "ItemType | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"li">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadItemNameProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadItemSizeTextProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FileUploadItemDeleteTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "floating-panel",
"types": [
{
"name": "FloatingPanelRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ trigger: string; positioner: string; content: string; title: string; header: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the floating panel. Useful for composition.",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The translations for the floating panel.",
"tags": []
}
},
{
"name": "strategy",
"type": ""absolute" | "fixed" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The strategy to use for positioning",
"tags": [
{
"name": "default",
"value": ""fixed""
}
]
}
},
{
"name": "allowOverflow",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel should be strictly contained within the boundary when dragging",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the panel",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the panel when rendered.\nUse when you don't need to control the open state of the panel.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "draggable",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel is draggable",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "resizable",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel is resizable",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "size",
"type": "Size | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The size of the panel",
"tags": []
}
},
{
"name": "defaultSize",
"type": "Size | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The default size of the panel",
"tags": []
}
},
{
"name": "minSize",
"type": "Size | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The minimum size of the panel",
"tags": []
}
},
{
"name": "maxSize",
"type": "Size | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The maximum size of the panel",
"tags": []
}
},
{
"name": "position",
"type": "Point | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The controlled position of the panel",
"tags": []
}
},
{
"name": "defaultPosition",
"type": "Point | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The initial position of the panel when rendered.\nUse when you don't need to control the position of the panel.",
"tags": []
}
},
{
"name": "getAnchorPosition",
"type": "((details: AnchorPositionDetails) => Point) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function that returns the initial position of the panel when it is opened.\nIf provided, will be used instead of the default position.",
"tags": []
}
},
{
"name": "lockAspectRatio",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel is locked to its aspect ratio",
"tags": []
}
},
{
"name": "closeOnEscape",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel should close when the escape key is pressed",
"tags": []
}
},
{
"name": "getBoundaryEl",
"type": "(() => HTMLElement | null) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The boundary of the panel. Useful for recalculating the boundary rect when\nthe it is resized.",
"tags": []
}
},
{
"name": "initialFocusEl",
"type": "(() => HTMLElement | null) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Element to receive focus when the panel is opened.\nBy default, the first focusable element in the content is focused.",
"tags": []
}
},
{
"name": "finalFocusEl",
"type": "(() => HTMLElement | null) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Element to receive focus when the panel is closed.\nBy default, the trigger element is focused.",
"tags": []
}
},
{
"name": "restoreFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to restore focus to the trigger when the panel is closed.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel is disabled",
"tags": []
}
},
{
"name": "onPositionChange",
"type": "((details: PositionChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the position of the panel changes via dragging",
"tags": []
}
},
{
"name": "onPositionChangeEnd",
"type": "((details: PositionChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the position of the panel changes via dragging ends",
"tags": []
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the panel is opened or closed",
"tags": []
}
},
{
"name": "onSizeChange",
"type": "((details: SizeChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the size of the panel changes via resizing",
"tags": []
}
},
{
"name": "onSizeChangeEnd",
"type": "((details: SizeChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the size of the panel changes via resizing ends",
"tags": []
}
},
{
"name": "persistRect",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the panel size and position should be preserved when it is closed",
"tags": []
}
},
{
"name": "gridSize",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The snap grid for the panel",
"tags": [
{
"name": "default",
"value": "1"
}
]
}
},
{
"name": "onStageChange",
"type": "((details: StageChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the stage of the panel changes",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "children",
"type": "Snippet<[]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The default slot content to be rendered within the component.",
"tags": []
}
}
]
},
{
"name": "FloatingPanelRootProviderProps",
"props": [
{
"name": "value",
"type": "() => FloatingPanelApi",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "children",
"type": "Snippet<[]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The default slot content to be rendered within the component.",
"tags": []
}
}
]
},
{
"name": "FloatingPanelRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[() => FloatingPanelApi]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "FloatingPanelTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelPositionerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelContentProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelDragTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelHeaderProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelTitleProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelControlProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelStageTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
},
{
"name": "stage",
"type": "Stage",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The stage of the panel",
"tags": []
}
}
]
},
{
"name": "FloatingPanelCloseTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelBodyProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "FloatingPanelResizeTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
},
{
"name": "axis",
"type": "ResizeTriggerAxis",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The axis of the resize handle",
"tags": []
}
}
]
}
]
},
{
"name": "listbox",
"types": [
{
"name": "ListboxRootProps",
"props": [
{
"name": "orientation",
"type": ""horizontal" | "vertical" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The orientation of the listbox.",
"tags": [
{
"name": "default",
"value": ""vertical""
}
]
}
},
{
"name": "collection",
"type": "ListCollection | GridCollection",
"typeKind": "object",
"optional": false,
"JSDoc": {
"description": "The item collection",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ root: string; content: string; label: string; item: (id: string | number) => string; itemGroup: (id: string | number) => string; itemGroupLabel: (id: string | number) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the listbox. Useful for composition.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the listbox is disabled",
"tags": []
}
},
{
"name": "disallowSelectAll",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to disallow selecting all items when meta+a is pressed",
"tags": []
}
},
{
"name": "onHighlightChange",
"type": "((details: HighlightChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The callback fired when the highlighted item changes.",
"tags": []
}
},
{
"name": "onValueChange",
"type": "((details: ValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The callback fired when the selected item changes.",
"tags": []
}
},
{
"name": "value",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The controlled keys of the selected items",
"tags": []
}
},
{
"name": "defaultValue",
"type": "string[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "The initial default value of the listbox when rendered.\nUse when you don't need to control the value of the listbox.",
"tags": [
{
"name": "default",
"value": "[]"
}
]
}
},
{
"name": "highlightedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled key of the highlighted item",
"tags": []
}
},
{
"name": "defaultHighlightedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial value of the highlighted item when opened.\nUse when you don't need to control the highlighted value of the listbox.",
"tags": []
}
},
{
"name": "loopFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to loop the keyboard navigation through the options",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "selectionMode",
"type": "SelectionMode | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "How multiple selection should behave in the listbox.\n\n- single: The user can select a single item.\n- multiple: The user can select multiple items without using modifier keys.\n- extended: The user can select multiple items by using modifier keys.",
"tags": [
{
"name": "default",
"value": ""single""
}
]
}
},
{
"name": "scrollToIndexFn",
"type": "((details: ScrollToIndexDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to scroll to a specific index",
"tags": []
}
},
{
"name": "selectOnHighlight",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to select the item when it is highlighted",
"tags": []
}
},
{
"name": "deselectable",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to disallow empty selection",
"tags": []
}
},
{
"name": "typeahead",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to enable typeahead on the listbox",
"tags": []
}
},
{
"name": "onSelect",
"type": "((details: SelectionDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an item is selected",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxRootProviderProps",
"props": [
{
"name": "value",
"type": "() => ListboxApi",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[() => ListboxApi]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "ListboxLabelProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"label">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxInputProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"input">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxContentProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"ul">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxItemGroupProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxItemGroupLabelProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxItemProps",
"props": [
{
"name": "item",
"type": "any",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The item to render",
"tags": []
}
},
{
"name": "highlightOnHover",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to highlight the item on hover",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"li">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxItemTextProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"span">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "ListboxItemIndicatorProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"span">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "locale-provider",
"types": [
{
"name": "LocaleProviderRootProps",
"props": [
{
"name": "locale",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The locale to use for the application.",
"tags": [
{
"name": "default",
"value": "'en-US'"
}
]
}
},
{
"name": "children",
"type": "Snippet<[]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The default slot content to be rendered within the component.",
"tags": []
}
}
]
},
{
"name": "LocaleProviderRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[any]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
}
]
},
{
"name": "marquee",
"types": [
{
"name": "MarqueeRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; viewport: string; content: (index: number) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the marquee. Useful for composition.",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The localized messages to use.",
"tags": []
}
},
{
"name": "side",
"type": "Side | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The side/direction the marquee scrolls towards.",
"tags": [
{
"name": "default",
"value": ""start""
}
]
}
},
{
"name": "speed",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The speed of the marquee animation in pixels per second.",
"tags": [
{
"name": "default",
"value": "50"
}
]
}
},
{
"name": "delay",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The delay before the animation starts (in seconds).",
"tags": [
{
"name": "default",
"value": "0"
}
]
}
},
{
"name": "loopCount",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The number of times to loop the animation (0 = infinite).",
"tags": [
{
"name": "default",
"value": "0"
}
]
}
},
{
"name": "spacing",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The spacing between marquee items.",
"tags": [
{
"name": "default",
"value": ""1rem""
}
]
}
},
{
"name": "autoFill",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to automatically duplicate content to fill the container.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "pauseOnInteraction",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to pause the marquee on user interaction (hover, focus).",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "reverse",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to reverse the animation direction.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "paused",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the marquee is paused.",
"tags": []
}
},
{
"name": "defaultPaused",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the marquee is paused by default.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "onPauseChange",
"type": "((details: PauseStatusDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the pause status changes.",
"tags": []
}
},
{
"name": "onLoopComplete",
"type": "(() => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the marquee completes one loop iteration.",
"tags": []
}
},
{
"name": "onComplete",
"type": "(() => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the marquee completes all loops and stops.\nOnly fires for finite loops (loopCount > 0).",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MarqueeRootProviderProps",
"props": [
{
"name": "value",
"type": "() => MarqueeApi",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MarqueeRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[() => MarqueeApi]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "MarqueeViewportProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MarqueeContentProps",
"props": [
{
"name": "index",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The index of the content instance (0 for original, 1+ for duplicates).",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MarqueeEdgeProps",
"props": [
{
"name": "side",
"type": "Side",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The side where the edge gradient should appear.",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "menu",
"types": [
{
"name": "MenuRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ trigger: string | ((value?: string | undefined) => string); contextTrigger: string | ((value?: string | undefined) => string); content: string; groupLabel: (id: string) => string; group: (id: string) => string; positioner: string; arrow: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the menu. Useful for composition.",
"tags": []
}
},
{
"name": "defaultHighlightedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial highlighted value of the menu item when rendered.\nUse when you don't need to control the highlighted value of the menu item.",
"tags": []
}
},
{
"name": "highlightedValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled highlighted value of the menu item.",
"tags": []
}
},
{
"name": "onHighlightChange",
"type": "((details: HighlightChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the highlighted menu item changes.",
"tags": []
}
},
{
"name": "onSelect",
"type": "((details: SelectionDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when a menu item is selected.",
"tags": []
}
},
{
"name": "anchorPoint",
"type": "Point | null | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The positioning point for the menu. Can be set by the context menu trigger or the button trigger.",
"tags": []
}
},
{
"name": "loopFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to loop the keyboard navigation.",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "positioning",
"type": "PositioningOptions | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The options used to dynamically position the menu",
"tags": []
}
},
{
"name": "closeOnSelect",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the menu when an option is selected",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "aria-label",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The accessibility label for the menu",
"tags": []
}
},
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the menu",
"tags": []
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the menu opens or closes",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the menu when rendered.\nUse when you don't need to control the open state of the menu.",
"tags": []
}
},
{
"name": "typeahead",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the pressing printable characters should trigger typeahead navigation",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "composite",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the menu is a composed with other composite widgets like a combobox or tabs",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "navigate",
"type": "((details: NavigateDetails) => void) | null | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to navigate to the selected item if it's an anchor element",
"tags": []
}
},
{
"name": "triggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled trigger value",
"tags": []
}
},
{
"name": "defaultTriggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial trigger value when rendered.\nUse when you don't need to control the trigger value.",
"tags": []
}
},
{
"name": "onTriggerValueChange",
"type": "((details: TriggerValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the trigger value changes.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "onEscapeKeyDown",
"type": "((event: KeyboardEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the escape key is pressed",
"tags": []
}
},
{
"name": "onRequestDismiss",
"type": "((event: LayerDismissEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when this layer is closed due to a parent layer being closed",
"tags": []
}
},
{
"name": "onPointerDownOutside",
"type": "((event: PointerDownOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the pointer is pressed down outside the component",
"tags": []
}
},
{
"name": "onFocusOutside",
"type": "((event: FocusOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the focus is moved outside the component",
"tags": []
}
},
{
"name": "onInteractOutside",
"type": "((event: InteractOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an interaction happens outside the component",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuRootProviderProps",
"props": [
{
"name": "value",
"type": "() => MenuApi & { service: MenuService; }",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "children",
"type": "Snippet<[]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "MenuRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[() => MenuApi & { service: MenuService; }]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "MenuTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuContextTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuIndicatorProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuPositionerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuContentProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuItemGroupProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuItemGroupLabelProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuItemProps",
"props": [
{
"name": "value",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The unique value of the menu item option.",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the menu item is disabled",
"tags": []
}
},
{
"name": "valueText",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The textual value of the option. Used in typeahead navigation of the menu.\nIf not provided, the text content of the menu item will be used.",
"tags": []
}
},
{
"name": "closeOnSelect",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the menu should be closed when the option is selected.",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuOptionItemProps",
"props": [
{
"name": "checked",
"type": "boolean",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "Whether the option is checked",
"tags": []
}
},
{
"name": "type",
"type": ""radio" | "checkbox"",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "Whether the option is a radio or a checkbox",
"tags": []
}
},
{
"name": "value",
"type": "string",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": "The value of the option",
"tags": []
}
},
{
"name": "onCheckedChange",
"type": "((checked: boolean) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the option state is changed",
"tags": []
}
},
{
"name": "disabled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the menu item is disabled",
"tags": []
}
},
{
"name": "valueText",
"type": "string | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The textual value of the option. Used in typeahead navigation of the menu.\nIf not provided, the text content of the menu item will be used.",
"tags": []
}
},
{
"name": "closeOnSelect",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the menu should be closed when the option is selected.",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuTriggerItemProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuItemTextProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuItemIndicatorProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuSeparatorProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"hr">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuArrowProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "MenuArrowTipProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "navigation",
"types": [
{
"name": "NavigationRootProps",
"props": [
{
"name": "layout",
"type": ""bar" | "rail" | "sidebar" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Sets the data-layout attribute, which modifies the visual presentation of the component set.",
"tags": [
{
"name": "default",
"value": "bar"
}
]
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationHeaderProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"header">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationContentProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationGroupProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationLabelProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationMenuProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationTriggerAnchorProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"anchor">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationTriggerTextProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"span">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "NavigationFooterProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"footer">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "pagination",
"types": [
{
"name": "PaginationRootProps",
"props": [
{
"name": "ids",
"type": "Partial<{ root: string; ellipsis: (index: number) => string; firstTrigger: string; prevTrigger: string; nextTrigger: string; lastTrigger: string; item: (page: number) => string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the accordion. Useful for composition.",
"tags": []
}
},
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "Specifies the localized strings that identifies the accessibility elements and their states",
"tags": []
}
},
{
"name": "count",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Total number of data items",
"tags": []
}
},
{
"name": "pageSize",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled number of data items per page",
"tags": []
}
},
{
"name": "defaultPageSize",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial number of data items per page when rendered.\nUse when you don't need to control the page size of the pagination.",
"tags": [
{
"name": "default",
"value": "10"
}
]
}
},
{
"name": "siblingCount",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Number of pages to show beside active page",
"tags": [
{
"name": "default",
"value": "1"
}
]
}
},
{
"name": "boundaryCount",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Number of pages to show at the beginning and end",
"tags": [
{
"name": "default",
"value": "1"
}
]
}
},
{
"name": "page",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled active page",
"tags": []
}
},
{
"name": "defaultPage",
"type": "number | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial active page when rendered.\nUse when you don't need to control the active page of the pagination.",
"tags": [
{
"name": "default",
"value": "1"
}
]
}
},
{
"name": "onPageChange",
"type": "((details: PageChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called when the page number is changed",
"tags": []
}
},
{
"name": "onPageSizeChange",
"type": "((details: PageSizeChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Called when the page size is changed",
"tags": []
}
},
{
"name": "type",
"type": ""button" | "link" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The type of the trigger element",
"tags": [
{
"name": "default",
"value": ""button""
}
]
}
},
{
"name": "getPageUrl",
"type": "((details: PageUrlDetails) => string) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function to generate href attributes for pagination links.\nOnly used when type is set to "link".",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationRootProviderProps",
"props": [
{
"name": "value",
"type": "() => PaginationApi",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"div">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationRootContextProps",
"props": [
{
"name": "children",
"type": "Snippet<[() => PaginationApi]>",
"typeKind": "function",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
}
]
},
{
"name": "PaginationFirstTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationPrevTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationItemProps",
"props": [
{
"name": "type",
"type": ""page"",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "value",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"a">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationEllipsisProps",
"props": [
{
"name": "index",
"type": "number",
"typeKind": "primitive",
"optional": false,
"JSDoc": {
"description": null,
"tags": []
}
},
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"span">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationNextTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
},
{
"name": "PaginationLastTriggerProps",
"props": [
{
"name": "element",
"type": "Snippet<[HTMLAttributes<"button">]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Render the element yourself",
"tags": []
}
}
]
}
]
},
{
"name": "popover",
"types": [
{
"name": "PopoverRootProps",
"props": [
{
"name": "translations",
"type": "IntlTranslations | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "Specifies the localized strings that identifies the accessibility elements and their states",
"tags": []
}
},
{
"name": "ids",
"type": "Partial<{ anchor: string; trigger: string | ((value?: string | undefined) => string); content: string; title: string; description: string; closeTrigger: string; positioner: string; arrow: string; }> | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The ids of the elements in the popover. Useful for composition.",
"tags": []
}
},
{
"name": "modal",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the popover should be modal. When set to true:\n- interaction with outside elements will be disabled\n- only popover content will be visible to screen readers\n- scrolling is blocked\n- focus is trapped within the popover",
"tags": [
{
"name": "default",
"value": "false"
}
]
}
},
{
"name": "portalled",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether the popover is portalled. This will proxy the tabbing behavior regardless of the DOM position\nof the popover content.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "autoFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to automatically set focus on the first focusable\ncontent within the popover when opened.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "initialFocusEl",
"type": "(() => HTMLElement | null) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The element to focus on when the popover is opened.",
"tags": []
}
},
{
"name": "finalFocusEl",
"type": "(() => MaybeElement) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Element to receive focus when the popover is closed.",
"tags": []
}
},
{
"name": "restoreFocus",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to restore focus to the element that had focus before the popover was opened.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "closeOnInteractOutside",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the popover when the user clicks outside of the popover.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "closeOnEscape",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "Whether to close the popover when the escape key is pressed.",
"tags": [
{
"name": "default",
"value": "true"
}
]
}
},
{
"name": "onOpenChange",
"type": "((details: OpenChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function invoked when the popover opens or closes",
"tags": []
}
},
{
"name": "positioning",
"type": "PositioningOptions | undefined",
"typeKind": "object",
"optional": true,
"JSDoc": {
"description": "The user provided options used to position the popover content",
"tags": []
}
},
{
"name": "open",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled open state of the popover",
"tags": []
}
},
{
"name": "defaultOpen",
"type": "boolean | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial open state of the popover when rendered.\nUse when you don't need to control the open state of the popover.",
"tags": []
}
},
{
"name": "triggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The controlled trigger value",
"tags": []
}
},
{
"name": "defaultTriggerValue",
"type": "string | null | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The initial trigger value when rendered.\nUse when you don't need to control the trigger value.",
"tags": []
}
},
{
"name": "onTriggerValueChange",
"type": "((details: TriggerValueChangeDetails) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the trigger value changes.",
"tags": []
}
},
{
"name": "getRootNode",
"type": "(() => ShadowRoot | Node | Document) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.",
"tags": []
}
},
{
"name": "dir",
"type": ""ltr" | "rtl" | undefined",
"typeKind": "primitive",
"optional": true,
"JSDoc": {
"description": "The document's text/writing direction.",
"tags": [
{
"name": "default",
"value": ""ltr""
}
]
}
},
{
"name": "onEscapeKeyDown",
"type": "((event: KeyboardEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the escape key is pressed",
"tags": []
}
},
{
"name": "onRequestDismiss",
"type": "((event: LayerDismissEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when this layer is closed due to a parent layer being closed",
"tags": []
}
},
{
"name": "onPointerDownOutside",
"type": "((event: PointerDownOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the pointer is pressed down outside the component",
"tags": []
}
},
{
"name": "onFocusOutside",
"type": "((event: FocusOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when the focus is moved outside the component",
"tags": []
}
},
{
"name": "onInteractOutside",
"type": "((event: InteractOutsideEvent) => void) | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "Function called when an interaction happens outside the component",
"tags": []
}
},
{
"name": "persistentElements",
"type": "(() => Element | null)[] | undefined",
"typeKind": "array",
"optional": true,
"JSDoc": {
"description": "Returns the persistent elements that:\n- should not have pointer-events disabled\n- should not trigger the dismiss event",
"tags": []
}
},
{
"name": "children",
"type": "Snippet<[]> | undefined",
"typeKind": "function",
"optional": true,
"JSDoc": {
"description": "The default slot content to be rendered within the component.",
"tags": []
}
}
]
},
{
"name": "PopoverRootProviderProps",
"props": [
{
"name": "value",
"type": "() => PopoverApi",
"typeKind": "function",
"optional": false,

Explore Related Technologies & Topics

View All 9,111+ Repositories →

Discover similar high-velocity repositories, agent skills, and OpenAPI specifications across the ecosystem.

#a11y Browse a11y catalog → #accessibility Browse accessibility catalog → #astro Browse astro catalog → #components Browse components catalog → #components-library Browse components-library catalog → #design Browse design catalog → ⚡ MCP Servers Model Context Protocol → 🧠 Agent Skills Prompt & rule files → 🔌 OpenAPI Specs REST & Swagger schemas →