diff --git a/docs/reference/generated/accordion-header.json b/docs/reference/generated/accordion-header.json new file mode 100644 index 0000000000..eacd7eb1c2 --- /dev/null +++ b/docs/reference/generated/accordion-header.json @@ -0,0 +1,14 @@ +{ + "name": "AccordionHeader", + "description": "", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/accordion-item.json b/docs/reference/generated/accordion-item.json new file mode 100644 index 0000000000..28ced50f2a --- /dev/null +++ b/docs/reference/generated/accordion-item.json @@ -0,0 +1,23 @@ +{ + "name": "AccordionItem", + "description": "", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "disabled": { + "type": "boolean", + "default": "false", + "description": "If `true`, the component is disabled." + }, + "onOpenChange": { + "type": "(open) => void", + "description": "Callback fired when the Collapsible is opened or closed." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/accordion-panel.json b/docs/reference/generated/accordion-panel.json new file mode 100644 index 0000000000..bf46dde288 --- /dev/null +++ b/docs/reference/generated/accordion-panel.json @@ -0,0 +1,19 @@ +{ + "name": "AccordionPanel", + "description": "", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "hiddenUntilFound": { + "type": "boolean", + "default": "false", + "description": "If `true`, sets `hidden=\"until-found\"` when closed.\nIf `false`, sets `hidden` when closed." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/accordion-root.json b/docs/reference/generated/accordion-root.json new file mode 100644 index 0000000000..222d772f12 --- /dev/null +++ b/docs/reference/generated/accordion-root.json @@ -0,0 +1,47 @@ +{ + "name": "AccordionRoot", + "description": "", + "props": { + "animated": { + "type": "boolean", + "default": "true", + "description": "If `true`, the component supports CSS/JS-based animations and transitions." + }, + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "defaultValue": { + "type": "Array", + "default": "0", + "description": "The default value representing the currently open `Accordion.Item`\nThis is the uncontrolled counterpart of `value`." + }, + "disabled": { + "type": "boolean", + "default": "false", + "description": "If `true`, the component is disabled." + }, + "loop": { + "type": "boolean", + "default": "true", + "description": "If `true`, focus will loop when moving focus between `Trigger`s using\nthe arrow keys." + }, + "onValueChange": { + "type": "(value) => void", + "description": "Callback fired when an Accordion section is opened or closed.\nThe value representing the involved section is provided as an argument." + }, + "openMultiple": { + "type": "boolean", + "default": "true", + "description": "Whether multiple Accordion sections can be opened at the same time" + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + }, + "value": { + "type": "Array", + "description": "The value of the currently open `Accordion.Item`\nThis is the controlled counterpart of `defaultValue`." + } + } +} diff --git a/docs/reference/generated/accordion-trigger.json b/docs/reference/generated/accordion-trigger.json new file mode 100644 index 0000000000..f6e6ae66f4 --- /dev/null +++ b/docs/reference/generated/accordion-trigger.json @@ -0,0 +1,14 @@ +{ + "name": "AccordionTrigger", + "description": "", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/alert-dialog-backdrop.json b/docs/reference/generated/alert-dialog-backdrop.json new file mode 100644 index 0000000000..a09e5f6699 --- /dev/null +++ b/docs/reference/generated/alert-dialog-backdrop.json @@ -0,0 +1,19 @@ +{ + "name": "AlertDialogBackdrop", + "description": "", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "keepMounted": { + "type": "boolean", + "default": "false", + "description": "If `true`, the backdrop element is kept in the DOM when closed." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/alert-dialog-close.json b/docs/reference/generated/alert-dialog-close.json new file mode 100644 index 0000000000..c050448528 --- /dev/null +++ b/docs/reference/generated/alert-dialog-close.json @@ -0,0 +1,14 @@ +{ + "name": "AlertDialogClose", + "description": "", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/alert-dialog-description.json b/docs/reference/generated/alert-dialog-description.json new file mode 100644 index 0000000000..b4f0642384 --- /dev/null +++ b/docs/reference/generated/alert-dialog-description.json @@ -0,0 +1,14 @@ +{ + "name": "AlertDialogDescription", + "description": "", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/alert-dialog-popup.json b/docs/reference/generated/alert-dialog-popup.json new file mode 100644 index 0000000000..ac6fde4db5 --- /dev/null +++ b/docs/reference/generated/alert-dialog-popup.json @@ -0,0 +1,31 @@ +{ + "name": "AlertDialogPopup", + "description": "", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "container": { + "type": "React.Ref | HTMLElement | null", + "description": "The container element to which the popup is appended to." + }, + "finalFocus": { + "type": "React.Ref", + "description": "Determines an element to focus after the dialog is closed.\nIf not provided, the focus returns to the trigger." + }, + "initialFocus": { + "type": "React.Ref | (interactionType => HTMLElement | null)", + "description": "Determines an element to focus when the dialog is opened.\nIt can be either a ref to the element or a function that returns such a ref.\nIf not provided, the first focusable element is focused." + }, + "keepMounted": { + "type": "boolean", + "default": "false", + "description": "If `true`, the dialog element is kept in the DOM when closed." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/alert-dialog-root.json b/docs/reference/generated/alert-dialog-root.json new file mode 100644 index 0000000000..7e6420324b --- /dev/null +++ b/docs/reference/generated/alert-dialog-root.json @@ -0,0 +1,23 @@ +{ + "name": "AlertDialogRoot", + "description": "", + "props": { + "animated": { + "type": "boolean", + "default": "true", + "description": "If `true`, the dialog supports CSS-based animations and transitions.\nIt is kept in the DOM until the animation completes." + }, + "defaultOpen": { + "type": "boolean", + "description": "Determines whether the dialog is initally open.\nThis is an uncontrolled equivalent of the `open` prop." + }, + "onOpenChange": { + "type": "(open, event) => void", + "description": "Callback invoked when the dialog is being opened or closed." + }, + "open": { + "type": "boolean", + "description": "Determines whether the dialog is open." + } + } +} diff --git a/docs/reference/generated/alert-dialog-title.json b/docs/reference/generated/alert-dialog-title.json new file mode 100644 index 0000000000..92e7c0c382 --- /dev/null +++ b/docs/reference/generated/alert-dialog-title.json @@ -0,0 +1,14 @@ +{ + "name": "AlertDialogTitle", + "description": "", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/alert-dialog-trigger.json b/docs/reference/generated/alert-dialog-trigger.json new file mode 100644 index 0000000000..24fd03d968 --- /dev/null +++ b/docs/reference/generated/alert-dialog-trigger.json @@ -0,0 +1,14 @@ +{ + "name": "AlertDialogTrigger", + "description": "", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/checkbox-group-root.json b/docs/reference/generated/checkbox-group-root.json new file mode 100644 index 0000000000..5d96c99720 --- /dev/null +++ b/docs/reference/generated/checkbox-group-root.json @@ -0,0 +1,40 @@ +{ + "name": "CheckboxGroupRoot", + "description": "The foundation for building custom-styled checkbox groups.", + "props": { + "allValues": { + "type": "string[]", + "description": "All values of the checkboxes in the group." + }, + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "defaultValue": { + "type": "string[]", + "description": "The default checked values of the checkbox group. Use when uncontrolled." + }, + "disabled": { + "type": "boolean", + "default": "false", + "description": "Whether the checkbox group is disabled." + }, + "onValueChange": { + "type": "(value, event) => void", + "description": "A callback function that is called when the value of the checkbox group changes.\nUse when controlled." + }, + "preserveChildStates": { + "type": "boolean", + "default": "false", + "description": "Whether the parent checkbox should preserve its child states when checked/unchecked, leading\nto a tri-state checkbox group." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + }, + "value": { + "type": "string[]", + "description": "The currently checked values of the checkbox group. Use when controlled." + } + } +} diff --git a/docs/reference/generated/checkbox-indicator.json b/docs/reference/generated/checkbox-indicator.json new file mode 100644 index 0000000000..48378078b8 --- /dev/null +++ b/docs/reference/generated/checkbox-indicator.json @@ -0,0 +1,19 @@ +{ + "name": "CheckboxIndicator", + "description": "The indicator part of the Checkbox.", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "keepMounted": { + "type": "boolean", + "default": "true", + "description": "If `true`, the indicator stays mounted when unchecked. Useful for CSS animations." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/checkbox-root.json b/docs/reference/generated/checkbox-root.json new file mode 100644 index 0000000000..dccc75e2d2 --- /dev/null +++ b/docs/reference/generated/checkbox-root.json @@ -0,0 +1,62 @@ +{ + "name": "CheckboxRoot", + "description": "The foundation for building custom-styled checkboxes.", + "props": { + "checked": { + "type": "boolean", + "default": "undefined", + "description": "If `true`, the component is checked." + }, + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "defaultChecked": { + "type": "boolean", + "default": "false", + "description": "The default checked state. Use when the component is not controlled." + }, + "disabled": { + "type": "boolean", + "default": "false", + "description": "If `true`, the component is disabled." + }, + "indeterminate": { + "type": "boolean", + "default": "false", + "description": "If `true`, the checkbox will be indeterminate." + }, + "inputRef": { + "type": "React.Ref", + "description": "The ref to the input element." + }, + "name": { + "type": "string", + "default": "undefined", + "description": "Name of the underlying input element." + }, + "onCheckedChange": { + "type": "(checked, event) => void", + "description": "Callback fired when the checked state is changed." + }, + "parent": { + "type": "boolean", + "default": "false", + "description": "If `true`, the checkbox is a parent checkbox for a group of child checkboxes." + }, + "readOnly": { + "type": "boolean", + "default": "false", + "description": "If `true`, the component is read only." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + }, + "required": { + "type": "boolean", + "default": "false", + "description": "If `true`, the `input` element is required." + } + } +} diff --git a/docs/reference/generated/collapsible-panel.json b/docs/reference/generated/collapsible-panel.json new file mode 100644 index 0000000000..56966e8771 --- /dev/null +++ b/docs/reference/generated/collapsible-panel.json @@ -0,0 +1,19 @@ +{ + "name": "CollapsiblePanel", + "description": "", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "hiddenUntilFound": { + "type": "boolean", + "default": "false", + "description": "If `true`, sets `hidden=\"until-found\"` when closed.\nIf `false`, sets `hidden` when closed." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/collapsible-root.json b/docs/reference/generated/collapsible-root.json new file mode 100644 index 0000000000..060f5a225d --- /dev/null +++ b/docs/reference/generated/collapsible-root.json @@ -0,0 +1,37 @@ +{ + "name": "CollapsibleRoot", + "description": "", + "props": { + "animated": { + "type": "boolean", + "default": "true", + "description": "If `true`, the component supports CSS/JS-based animations and transitions." + }, + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "defaultOpen": { + "type": "boolean", + "default": "true", + "description": "If `true`, the Collapsible is initially open.\nThis is the uncontrolled counterpart of `open`." + }, + "disabled": { + "type": "boolean", + "default": "false", + "description": "If `true`, the component is disabled." + }, + "onOpenChange": { + "type": "(open) => void", + "description": "Callback fired when the Collapsible is opened or closed." + }, + "open": { + "type": "boolean", + "description": "If `true`, the Collapsible is initially open.\nThis is the controlled counterpart of `defaultOpen`." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/collapsible-trigger.json b/docs/reference/generated/collapsible-trigger.json new file mode 100644 index 0000000000..903a24d148 --- /dev/null +++ b/docs/reference/generated/collapsible-trigger.json @@ -0,0 +1,14 @@ +{ + "name": "CollapsibleTrigger", + "description": "", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/dialog-backdrop.json b/docs/reference/generated/dialog-backdrop.json new file mode 100644 index 0000000000..7ac90105e9 --- /dev/null +++ b/docs/reference/generated/dialog-backdrop.json @@ -0,0 +1,33 @@ +{ + "name": "DialogBackdrop", + "description": "An overlay displayed beneath the popup. Renders a `
` element.", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "keepMounted": { + "type": "boolean", + "default": "false", + "description": "If `true`, the backdrop element is kept in the DOM when closed." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + }, + "attributes": { + "[data-open]": { + "description": "Present when the dialog is open." + }, + "[data-closed]": { + "description": "Present when the dialog is closed." + }, + "[data-entering]": { + "description": "Present when the dialog is animating in." + }, + "[data-exiting]": { + "description": "Present when the dialog is animating out." + } + } +} diff --git a/docs/reference/generated/dialog-close.json b/docs/reference/generated/dialog-close.json new file mode 100644 index 0000000000..575df807eb --- /dev/null +++ b/docs/reference/generated/dialog-close.json @@ -0,0 +1,14 @@ +{ + "name": "DialogClose", + "description": "", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/dialog-description.json b/docs/reference/generated/dialog-description.json new file mode 100644 index 0000000000..2dfee8fd53 --- /dev/null +++ b/docs/reference/generated/dialog-description.json @@ -0,0 +1,14 @@ +{ + "name": "DialogDescription", + "description": "A paragraph with additional information about the dialog. Renders a `

` element.", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/dialog-popup.json b/docs/reference/generated/dialog-popup.json new file mode 100644 index 0000000000..789b2b1c37 --- /dev/null +++ b/docs/reference/generated/dialog-popup.json @@ -0,0 +1,58 @@ +{ + "name": "DialogPopup", + "description": "A container for the dialog contents. Renders a `

` element.", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "container": { + "type": "React.Ref | HTMLElement | null", + "description": "The container element to which the popup is appended to." + }, + "finalFocus": { + "type": "React.Ref", + "description": "Determines an element to focus after the dialog is closed.\nIf not provided, the focus returns to the trigger." + }, + "initialFocus": { + "type": "React.Ref | (interactionType => HTMLElement | null)", + "description": "Determines an element to focus when the dialog is opened.\nIt can be either a ref to the element or a function that returns such a ref.\nIf not provided, the first focusable element is focused." + }, + "keepMounted": { + "type": "boolean", + "default": "false", + "description": "If `true`, the dialog element is kept in the DOM when closed." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + }, + "attributes": { + "[data-open]": { + "description": "Present when the dialog is open." + }, + "[data-closed]": { + "description": "Present when the dialog is closed." + }, + "[data-entering]": { + "description": "Present when the dialog is animating in." + }, + "[data-exiting]": { + "description": "Present when the dialog is animating out." + }, + "[data-modal]": { + "description": "Present when the dialog is modal." + }, + "[data-nested-dialogs]": { + "type": "number", + "description": "Indicates how many dialogs are nested within." + } + }, + "cssVariables": { + "--nested-dialogs": { + "type": "number", + "description": "Indicates how many dialogs are nested within." + } + } +} diff --git a/docs/reference/generated/dialog-root.json b/docs/reference/generated/dialog-root.json new file mode 100644 index 0000000000..af19098732 --- /dev/null +++ b/docs/reference/generated/dialog-root.json @@ -0,0 +1,33 @@ +{ + "name": "DialogRoot", + "description": "Groups all parts of the dialog. Doesn’t render its own HTML element.", + "props": { + "animated": { + "type": "boolean", + "default": "true", + "description": "If `true`, the dialog supports CSS-based animations and transitions.\nIt is kept in the DOM until the animation completes." + }, + "defaultOpen": { + "type": "boolean", + "description": "Determines whether the dialog is initally open.\nThis is an uncontrolled equivalent of the `open` prop." + }, + "dismissible": { + "type": "boolean", + "default": "true", + "description": "Determines whether the dialog should close when clicking outside of it." + }, + "modal": { + "type": "boolean", + "default": "true", + "description": "Determines whether the dialog is modal." + }, + "onOpenChange": { + "type": "(open, event) => void", + "description": "Callback invoked when the dialog is being opened or closed." + }, + "open": { + "type": "boolean", + "description": "Determines whether the dialog is open." + } + } +} diff --git a/docs/reference/generated/dialog-title.json b/docs/reference/generated/dialog-title.json new file mode 100644 index 0000000000..3afaead6da --- /dev/null +++ b/docs/reference/generated/dialog-title.json @@ -0,0 +1,14 @@ +{ + "name": "DialogTitle", + "description": "A heading that labels the dialog. Renders an `

` element.", + "props": { + "className": { + "type": "string | (state) => string", + "description": "Class names applied to the element or a function that returns them based on the component's state." + }, + "render": { + "type": "React.ReactElement | (props, state) => React.ReactElement", + "description": "A function to customize rendering of the component." + } + } +} diff --git a/docs/reference/generated/dialog-trigger.json b/docs/reference/generated/dialog-trigger.json new file mode 100644 index 0000000000..0336866143 --- /dev/null +++ b/docs/reference/generated/dialog-trigger.json @@ -0,0 +1,22 @@ +{ + "name": "DialogTrigger", + "description": "A button that opens the dialog. Renders a `