Skip to content

Commit

Permalink
docs:api
Browse files Browse the repository at this point in the history
  • Loading branch information
michaldudak committed Nov 18, 2024
1 parent 133db84 commit 74e08b7
Show file tree
Hide file tree
Showing 118 changed files with 2,992 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/reference/generated/accordion-header.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
23 changes: 23 additions & 0 deletions docs/reference/generated/accordion-item.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
19 changes: 19 additions & 0 deletions docs/reference/generated/accordion-panel.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
47 changes: 47 additions & 0 deletions docs/reference/generated/accordion-root.json
Original file line number Diff line number Diff line change
@@ -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<number | string>",
"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<number | string>",
"description": "The value of the currently open `Accordion.Item`\nThis is the controlled counterpart of `defaultValue`."
}
}
}
14 changes: 14 additions & 0 deletions docs/reference/generated/accordion-trigger.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
19 changes: 19 additions & 0 deletions docs/reference/generated/alert-dialog-backdrop.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
14 changes: 14 additions & 0 deletions docs/reference/generated/alert-dialog-close.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
14 changes: 14 additions & 0 deletions docs/reference/generated/alert-dialog-description.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
31 changes: 31 additions & 0 deletions docs/reference/generated/alert-dialog-popup.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
23 changes: 23 additions & 0 deletions docs/reference/generated/alert-dialog-root.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
14 changes: 14 additions & 0 deletions docs/reference/generated/alert-dialog-title.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
14 changes: 14 additions & 0 deletions docs/reference/generated/alert-dialog-trigger.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
40 changes: 40 additions & 0 deletions docs/reference/generated/checkbox-group-root.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
19 changes: 19 additions & 0 deletions docs/reference/generated/checkbox-indicator.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
62 changes: 62 additions & 0 deletions docs/reference/generated/checkbox-root.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
}
Loading

0 comments on commit 74e08b7

Please sign in to comment.