Skip to content

Commit

Permalink
[docs] Custom props order (#1090)
Browse files Browse the repository at this point in the history
  • Loading branch information
vladmoroz authored Dec 13, 2024
1 parent 51d6c10 commit adf3bee
Show file tree
Hide file tree
Showing 134 changed files with 1,564 additions and 1,421 deletions.
9 changes: 5 additions & 4 deletions docs/reference/generated/accordion-header.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,16 @@
}
},
"dataAttributes": {
"data-open": {
"description": "Present when the accordion item is open."
},
"data-disabled": {
"description": "Present when the accordion item is disabled."
},
"data-index": {
"description": "Indicates the index of the accordion item.",
"type": "number"
},
"data-open": {
"description": "Present when the accordion item is open."
}
}
},
"cssVariables": {}
}
21 changes: 11 additions & 10 deletions docs/reference/generated/accordion-item.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,35 @@
"name": "AccordionItem",
"description": "Groups an accordion header with the corresponding panel.\nRenders a `<div>` element.",
"props": {
"className": {
"type": "string | (state) => string",
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component’s state."
"onOpenChange": {
"type": "(open) => void",
"description": "Event handler called when the panel is opened or closed."
},
"disabled": {
"type": "boolean",
"default": "false",
"description": "Whether the component should ignore user interaction."
},
"onOpenChange": {
"type": "(open) => void",
"description": "Event handler called when the panel is opened or closed."
"className": {
"type": "string | (state) => string",
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component’s state."
},
"render": {
"type": "React.ReactElement | (props, state) => React.ReactElement",
"description": "Allows you to replace the component’s HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
}
},
"dataAttributes": {
"data-open": {
"description": "Present when the accordion item is open."
},
"data-disabled": {
"description": "Present when the accordion item is disabled."
},
"data-index": {
"description": "Indicates the index of the accordion item.",
"type": "number"
},
"data-open": {
"description": "Present when the accordion item is open."
}
}
},
"cssVariables": {}
}
31 changes: 11 additions & 20 deletions docs/reference/generated/accordion-panel.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
"name": "AccordionPanel",
"description": "A collapsible panel with the accordion item contents.\nRenders a `<div>` element.",
"props": {
"className": {
"type": "string | (state) => string",
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component’s state."
},
"hiddenUntilFound": {
"type": "boolean",
"default": "false",
"description": "Allows the browser’s built-in page search to find and expand the panel contents.\n\nOverrides the `keepMounted` prop and uses `hidden=\"until-found\"`\nto hide the element without removing it from the DOM."
},
"className": {
"type": "string | (state) => string",
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component’s state."
},
"keepMounted": {
"type": "boolean",
"default": "false",
Expand All @@ -22,31 +22,22 @@
}
},
"dataAttributes": {
"data-open": {
"description": "Present when the accordion panel is open."
},
"data-disabled": {
"description": "Present when the accordion item is disabled."
},
"data-ending-style": {
"description": "Present when the panel is animating out."
},
"data-index": {
"description": "Indicates the index of the accordion item.",
"type": "number"
},
"data-open": {
"description": "Present when the accordion panel is open."
},
"data-starting-style": {
"description": "Present when the panel is animating in."
}
},
"cssVariables": {
"--accordion-panel-height": {
"description": "The accordion panel's height.",
"type": "number"
},
"--accordion-panel-width": {
"description": "The accordion panel's width.",
"type": "number"
"data-ending-style": {
"description": "Present when the panel is animating out."
}
}
},
"cssVariables": {}
}
49 changes: 25 additions & 24 deletions docs/reference/generated/accordion-root.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,60 +2,61 @@
"name": "AccordionRoot",
"description": "Groups all parts of the accordion.\nRenders a `<div>` element.",
"props": {
"className": {
"type": "string | (state) => string",
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component’s state."
},
"defaultValue": {
"type": "array",
"description": "The uncontrolled value of the item(s) that should be initially expanded.\n\nTo render a controlled accordion, use the `value` prop instead."
},
"disabled": {
"type": "boolean",
"default": "false",
"description": "Whether the component should ignore user interaction."
"value": {
"type": "array",
"description": "The controlled value of the item(s) that should be expanded.\n\nTo render an uncontrolled accordion, use the `defaultValue` prop instead."
},
"onValueChange": {
"type": "(value) => void",
"description": "Event handler called when an accordion item is expanded or collapsed.\nProvides the new value as an argument."
},
"hiddenUntilFound": {
"type": "boolean",
"default": "false",
"description": "Allows the browser’s built-in page search to find and expand the panel contents.\n\nOverrides the `keepMounted` prop and uses `hidden=\"until-found\"`\nto hide the element without removing it from the DOM."
},
"keepMounted": {
"openMultiple": {
"type": "boolean",
"default": "true",
"description": "Whether multiple items can be open at the same time."
},
"disabled": {
"type": "boolean",
"default": "false",
"description": "Whether to keep the element in the DOM while the panel is closed.\nThis prop is ignored when `hiddenUntilFound` is used."
"description": "Whether the component should ignore user interaction."
},
"loop": {
"type": "boolean",
"default": "true",
"description": "Whether to loop keyboard focus back to the first item\nwhen the end of the list is reached while using the arrow keys."
},
"onValueChange": {
"type": "(value) => void",
"description": "Event handler called when an accordion item is expanded or collapsed.\nProvides the new value as an argument."
},
"openMultiple": {
"type": "boolean",
"default": "true",
"description": "Whether multiple items can be open at the same time."
},
"orientation": {
"type": "'horizontal' | 'vertical'",
"default": "'vertical'",
"description": "The visual orientation of the accordion.\nControls whether roving focus uses left/right or up/down arrow keys."
},
"className": {
"type": "string | (state) => string",
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component’s state."
},
"keepMounted": {
"type": "boolean",
"default": "false",
"description": "Whether to keep the element in the DOM while the panel is closed.\nThis prop is ignored when `hiddenUntilFound` is used."
},
"render": {
"type": "React.ReactElement | (props, state) => React.ReactElement",
"description": "Allows you to replace the component’s HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
},
"value": {
"type": "array",
"description": "The controlled value of the item(s) that should be expanded.\n\nTo render an uncontrolled accordion, use the `defaultValue` prop instead."
}
},
"dataAttributes": {
"data-disabled": {
"description": "Present when the accordion is disabled."
}
}
},
"cssVariables": {}
}
9 changes: 5 additions & 4 deletions docs/reference/generated/accordion-trigger.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@
}
},
"dataAttributes": {
"data-disabled": {
"description": "Present when the accordion item is disabled."
},
"data-panel-open": {
"description": "Present when the accordion panel is open."
},
"data-disabled": {
"description": "Present when the accordion item is disabled."
}
}
},
"cssVariables": {}
}
15 changes: 8 additions & 7 deletions docs/reference/generated/alert-dialog-backdrop.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,18 @@
}
},
"dataAttributes": {
"data-closed": {
"description": "Present when the dialog is closed."
},
"data-ending-style": {
"description": "Present when the dialog is animating out."
},
"data-open": {
"description": "Present when the dialog is open."
},
"data-closed": {
"description": "Present when the dialog is closed."
},
"data-starting-style": {
"description": "Present when the dialog is animating in."
},
"data-ending-style": {
"description": "Present when the dialog is animating out."
}
}
},
"cssVariables": {}
}
4 changes: 3 additions & 1 deletion docs/reference/generated/alert-dialog-close.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,7 @@
"type": "React.ReactElement | (props, state) => React.ReactElement",
"description": "Allows you to replace the component’s HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
}
}
},
"dataAttributes": {},
"cssVariables": {}
}
4 changes: 3 additions & 1 deletion docs/reference/generated/alert-dialog-description.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,7 @@
"type": "React.ReactElement | (props, state) => React.ReactElement",
"description": "Allows you to replace the component’s HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
}
}
},
"dataAttributes": {},
"cssVariables": {}
}
27 changes: 14 additions & 13 deletions docs/reference/generated/alert-dialog-popup.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
"name": "AlertDialogPopup",
"description": "A container for the alert dialog contents.\nRenders a `<div>` element.",
"props": {
"className": {
"type": "string | (state) => string",
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component’s state."
"initialFocus": {
"type": "React.Ref | (interactionType => HTMLElement | null)",
"description": "Determines the element to focus when the dialog is opened.\nBy default, the first focusable element is focused."
},
"finalFocus": {
"type": "React.Ref",
"description": "Determines the element to focus when the dialog is closed.\nBy default, focus returns to the trigger."
},
"initialFocus": {
"type": "React.Ref | (interactionType => HTMLElement | null)",
"description": "Determines the element to focus when the dialog is opened.\nBy default, the first focusable element is focused."
"className": {
"type": "string | (state) => string",
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component’s state."
},
"keepMounted": {
"type": "boolean",
Expand All @@ -25,21 +25,22 @@
}
},
"dataAttributes": {
"data-open": {
"description": "Present when the dialog is open."
},
"data-closed": {
"description": "Present when the dialog is closed."
},
"data-ending-style": {
"description": "Present when the dialog is animating out."
},
"data-nested-dialogs": {
"description": "Indicates how many dialogs are nested within.",
"type": "number"
},
"data-open": {
"description": "Present when the dialog is open."
},
"data-starting-style": {
"description": "Present when the dialog is animating in."
},
"data-ending-style": {
"description": "Present when the dialog is animating out."
}
}
},
"cssVariables": {}
}
12 changes: 7 additions & 5 deletions docs/reference/generated/alert-dialog-root.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@
"default": "false",
"description": "Whether the dialog is initially open.\n\nTo render a controlled dialog, use the `open` prop instead."
},
"onOpenChange": {
"type": "(open, event) => void",
"description": "Event handler called when the dialog is opened or closed."
},
"open": {
"type": "boolean",
"description": "Whether the dialog is currently open."
},
"onOpenChange": {
"type": "(open, event) => void",
"description": "Event handler called when the dialog is opened or closed."
}
}
},
"dataAttributes": {},
"cssVariables": {}
}
4 changes: 3 additions & 1 deletion docs/reference/generated/alert-dialog-title.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,7 @@
"type": "React.ReactElement | (props, state) => React.ReactElement",
"description": "Allows you to replace the component’s HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
}
}
},
"dataAttributes": {},
"cssVariables": {}
}
3 changes: 2 additions & 1 deletion docs/reference/generated/alert-dialog-trigger.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@
"data-popup-open": {
"description": "Present when the corresponding dialog is open."
}
}
},
"cssVariables": {}
}
Loading

0 comments on commit adf3bee

Please sign in to comment.