Skip to content

Commit

Permalink
docs:api
Browse files Browse the repository at this point in the history
  • Loading branch information
atomiks committed Dec 4, 2024
1 parent aa86ee0 commit 79a9d79
Show file tree
Hide file tree
Showing 83 changed files with 517 additions and 593 deletions.
7 changes: 0 additions & 7 deletions docs/data/api/accordion-panel.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,6 @@
"imports": [
"import { Accordion } from '@base-ui-components/react/accordion';\nconst AccordionPanel = Accordion.Panel;"
],
"cssVariables": {
"--accordion-panel-height": {
"description": "The accordion panel's height.",
"type": "number"
},
"--accordion-panel-width": { "description": "The accordion panel's width.", "type": "number" }
},
"classes": [],
"spread": true,
"themeDefaultProps": true,
Expand Down
1 change: 0 additions & 1 deletion docs/data/api/alert-dialog-popup.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"props": {
"className": { "type": { "name": "union", "description": "func<br>&#124;&nbsp;string" } },
"container": { "type": { "name": "union", "description": "HTML element<br>&#124;&nbsp;ref" } },
"finalFocus": { "type": { "name": "custom", "description": "ref" } },
"initialFocus": { "type": { "name": "union", "description": "func<br>&#124;&nbsp;ref" } },
"keepMounted": { "type": { "name": "bool" }, "default": "false" },
Expand Down
10 changes: 9 additions & 1 deletion docs/data/api/alert-dialog-portal.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
{
"props": {},
"props": {
"container": {
"type": {
"name": "union",
"description": "(props, propName) => {\n if (props[propName] == null) {\n return new Error(`Prop '${propName}' is required but wasn't specified`);\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n}<br>&#124;&nbsp;{ current?: (props, propName) => {\n if (props[propName] == null) {\n return null;\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n} }"
}
},
"keepMounted": { "type": { "name": "bool" }, "default": "false" }
},
"name": "AlertDialogPortal",
"imports": [
"import { AlertDialog } from '@base-ui-components/react/alert-dialog';\nconst AlertDialogPortal = AlertDialog.Portal;"
Expand Down
10 changes: 0 additions & 10 deletions docs/data/api/collapsible-panel.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,6 @@
"imports": [
"import { Collapsible } from '@base-ui-components/react/collapsible';\nconst CollapsiblePanel = Collapsible.Panel;"
],
"cssVariables": {
"--collapsible-panel-height": {
"description": "The collapsible panel's height.",
"type": "number"
},
"--collapsible-panel-width": {
"description": "The collapsible panel's width.",
"type": "number"
}
},
"classes": [],
"spread": true,
"themeDefaultProps": true,
Expand Down
7 changes: 0 additions & 7 deletions docs/data/api/dialog-popup.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"props": {
"className": { "type": { "name": "union", "description": "func<br>&#124;&nbsp;string" } },
"container": { "type": { "name": "union", "description": "HTML element<br>&#124;&nbsp;ref" } },
"finalFocus": { "type": { "name": "custom", "description": "ref" } },
"initialFocus": { "type": { "name": "union", "description": "func<br>&#124;&nbsp;ref" } },
"keepMounted": { "type": { "name": "bool" }, "default": "false" },
Expand All @@ -11,12 +10,6 @@
"imports": [
"import { Dialog } from '@base-ui-components/react/dialog';\nconst DialogPopup = Dialog.Popup;"
],
"cssVariables": {
"--nested-dialogs": {
"description": "Indicates how many dialogs are nested within.",
"type": "number"
}
},
"classes": [],
"spread": true,
"themeDefaultProps": true,
Expand Down
10 changes: 9 additions & 1 deletion docs/data/api/dialog-portal.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
{
"props": {},
"props": {
"container": {
"type": {
"name": "union",
"description": "(props, propName) => {\n if (props[propName] == null) {\n return new Error(`Prop '${propName}' is required but wasn't specified`);\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n}<br>&#124;&nbsp;{ current?: (props, propName) => {\n if (props[propName] == null) {\n return null;\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n} }"
}
},
"keepMounted": { "type": { "name": "bool" }, "default": "false" }
},
"name": "DialogPortal",
"imports": [
"import { Dialog } from '@base-ui-components/react/dialog';\nconst DialogPortal = Dialog.Portal;"
Expand Down
10 changes: 9 additions & 1 deletion docs/data/api/menu-portal.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
{
"props": {},
"props": {
"container": {
"type": {
"name": "union",
"description": "(props, propName) => {\n if (props[propName] == null) {\n return new Error(`Prop '${propName}' is required but wasn't specified`);\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n}<br>&#124;&nbsp;{ current?: (props, propName) => {\n if (props[propName] == null) {\n return null;\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n} }"
}
},
"keepMounted": { "type": { "name": "bool" }, "default": "false" }
},
"name": "MenuPortal",
"imports": [
"import { Menu } from '@base-ui-components/react/menu';\nconst MenuPortal = Menu.Portal;"
Expand Down
17 changes: 0 additions & 17 deletions docs/data/api/menu-positioner.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
},
"default": "5"
},
"container": { "type": { "name": "union", "description": "HTML element<br>&#124;&nbsp;func" } },
"keepMounted": { "type": { "name": "bool" }, "default": "false" },
"positionMethod": {
"type": { "name": "enum", "description": "'absolute'<br>&#124;&nbsp;'fixed'" },
Expand All @@ -51,22 +50,6 @@
"imports": [
"import { Menu } from '@base-ui-components/react/menu';\nconst MenuPositioner = Menu.Positioner;"
],
"cssVariables": {
"--anchor-height": { "description": "The anchor's height.", "type": "number" },
"--anchor-width": { "description": "The anchor's width.", "type": "number" },
"--available-height": {
"description": "The available height between the trigger and the edge of the viewport.",
"type": "number"
},
"--available-width": {
"description": "The available width between the trigger and the edge of the viewport.",
"type": "number"
},
"--transform-origin": {
"description": "The coordinates that this element is anchored to. Used for animations and transitions.",
"type": "string"
}
},
"classes": [],
"spread": true,
"themeDefaultProps": true,
Expand Down
4 changes: 0 additions & 4 deletions docs/data/api/popover-backdrop.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
{
"props": {
"className": { "type": { "name": "union", "description": "func<br>&#124;&nbsp;string" } },
"container": {
"type": { "name": "union", "description": "HTML element<br>&#124;&nbsp;func" },
"default": "false"
},
"keepMounted": { "type": { "name": "bool" }, "default": "false" },
"render": { "type": { "name": "union", "description": "element<br>&#124;&nbsp;func" } }
},
Expand Down
10 changes: 9 additions & 1 deletion docs/data/api/popover-portal.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
{
"props": {},
"props": {
"container": {
"type": {
"name": "union",
"description": "(props, propName) => {\n if (props[propName] == null) {\n return new Error(`Prop '${propName}' is required but wasn't specified`);\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n}<br>&#124;&nbsp;{ current?: (props, propName) => {\n if (props[propName] == null) {\n return null;\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n} }"
}
},
"keepMounted": { "type": { "name": "bool" }, "default": "false" }
},
"name": "PopoverPortal",
"imports": [
"import { Popover } from '@base-ui-components/react/popover';\nconst PopoverPortal = Popover.Portal;"
Expand Down
17 changes: 0 additions & 17 deletions docs/data/api/popover-positioner.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
},
"default": "5"
},
"container": { "type": { "name": "union", "description": "HTML element<br>&#124;&nbsp;func" } },
"keepMounted": { "type": { "name": "bool" }, "default": "false" },
"positionMethod": {
"type": { "name": "enum", "description": "'absolute'<br>&#124;&nbsp;'fixed'" },
Expand All @@ -51,22 +50,6 @@
"imports": [
"import { Popover } from '@base-ui-components/react/popover';\nconst PopoverPositioner = Popover.Positioner;"
],
"cssVariables": {
"--anchor-height": { "description": "The anchor's height.", "type": "number" },
"--anchor-width": { "description": "The anchor's width.", "type": "number" },
"--available-height": {
"description": "The available height between the trigger and the edge of the viewport.",
"type": "number"
},
"--available-width": {
"description": "The available width between the trigger and the edge of the viewport.",
"type": "number"
},
"--transform-origin": {
"description": "The coordinates that this element is anchored to. Used for animations and transitions.",
"type": "string"
}
},
"classes": [],
"spread": true,
"themeDefaultProps": true,
Expand Down
1 change: 0 additions & 1 deletion docs/data/api/preview-card-backdrop.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"props": {
"className": { "type": { "name": "union", "description": "func<br>&#124;&nbsp;string" } },
"container": { "type": { "name": "union", "description": "HTML element<br>&#124;&nbsp;func" } },
"keepMounted": { "type": { "name": "bool" }, "default": "false" },
"render": { "type": { "name": "union", "description": "element<br>&#124;&nbsp;func" } }
},
Expand Down
10 changes: 9 additions & 1 deletion docs/data/api/preview-card-portal.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
{
"props": {},
"props": {
"container": {
"type": {
"name": "union",
"description": "(props, propName) => {\n if (props[propName] == null) {\n return new Error(`Prop '${propName}' is required but wasn't specified`);\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n}<br>&#124;&nbsp;{ current?: (props, propName) => {\n if (props[propName] == null) {\n return null;\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n} }"
}
},
"keepMounted": { "type": { "name": "bool" }, "default": "false" }
},
"name": "PreviewCardPortal",
"imports": [
"import { PreviewCard } from '@base-ui-components/react/preview-card';\nconst PreviewCardPortal = PreviewCard.Portal;"
Expand Down
17 changes: 0 additions & 17 deletions docs/data/api/preview-card-positioner.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
},
"default": "5"
},
"container": { "type": { "name": "union", "description": "HTML element<br>&#124;&nbsp;func" } },
"keepMounted": { "type": { "name": "bool" }, "default": "false" },
"positionMethod": {
"type": { "name": "enum", "description": "'absolute'<br>&#124;&nbsp;'fixed'" },
Expand All @@ -51,22 +50,6 @@
"imports": [
"import { PreviewCard } from '@base-ui-components/react/preview-card';\nconst PreviewCardPositioner = PreviewCard.Positioner;"
],
"cssVariables": {
"--anchor-height": { "description": "The anchor's height.", "type": "number" },
"--anchor-width": { "description": "The anchor's width.", "type": "number" },
"--available-height": {
"description": "The available height between the trigger and the edge of the viewport.",
"type": "number"
},
"--available-width": {
"description": "The available width between the trigger and the edge of the viewport.",
"type": "number"
},
"--transform-origin": {
"description": "The coordinates that this element is anchored to. Used for animations and transitions.",
"type": "string"
}
},
"classes": [],
"spread": true,
"themeDefaultProps": true,
Expand Down
10 changes: 0 additions & 10 deletions docs/data/api/scroll-area-root.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,6 @@
"imports": [
"import { ScrollArea } from '@base-ui-components/react/scroll-area';\nconst ScrollAreaRoot = ScrollArea.Root;"
],
"cssVariables": {
"--scroll-area-corner-height": {
"description": "The scroll area's corner height.",
"type": "number"
},
"--scroll-area-corner-width": {
"description": "The scroll area's corner width.",
"type": "number"
}
},
"classes": [],
"spread": true,
"themeDefaultProps": true,
Expand Down
10 changes: 0 additions & 10 deletions docs/data/api/scroll-area-scrollbar.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,6 @@
"imports": [
"import { ScrollArea } from '@base-ui-components/react/scroll-area';\nconst ScrollAreaScrollbar = ScrollArea.Scrollbar;"
],
"cssVariables": {
"--scroll-area-thumb-height": {
"description": "The scroll area thumb's height.",
"type": "number"
},
"--scroll-area-thumb-width": {
"description": "The scroll area thumb's width.",
"type": "number"
}
},
"classes": [],
"spread": true,
"themeDefaultProps": true,
Expand Down
4 changes: 0 additions & 4 deletions docs/data/api/select-backdrop.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
{
"props": {
"className": { "type": { "name": "union", "description": "func<br>&#124;&nbsp;string" } },
"container": {
"type": { "name": "union", "description": "HTML element<br>&#124;&nbsp;func" },
"default": "false"
},
"keepMounted": { "type": { "name": "bool" }, "default": "false" },
"render": { "type": { "name": "union", "description": "element<br>&#124;&nbsp;func" } }
},
Expand Down
10 changes: 9 additions & 1 deletion docs/data/api/select-portal.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
{
"props": {},
"props": {
"container": {
"type": {
"name": "union",
"description": "(props, propName) => {\n if (props[propName] == null) {\n return new Error(`Prop '${propName}' is required but wasn't specified`);\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n}<br>&#124;&nbsp;{ current?: (props, propName) => {\n if (props[propName] == null) {\n return null;\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n} }"
}
},
"keepMounted": { "type": { "name": "bool" }, "default": "false" }
},
"name": "SelectPortal",
"imports": [
"import { Select } from '@base-ui-components/react/select';\nconst SelectPortal = Select.Portal;"
Expand Down
22 changes: 0 additions & 22 deletions docs/data/api/select-positioner.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,6 @@
},
"default": "5"
},
"container": {
"type": {
"name": "union",
"description": "(props, propName) => {\n if (props[propName] == null) {\n return new Error(`Prop '${propName}' is required but wasn't specified`);\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n}<br>&#124;&nbsp;{ current?: (props, propName) => {\n if (props[propName] == null) {\n return null;\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n} }"
}
},
"positionMethod": {
"type": { "name": "enum", "description": "'absolute'<br>&#124;&nbsp;'fixed'" },
"default": "'absolute'"
Expand All @@ -56,22 +50,6 @@
"imports": [
"import { Select } from '@base-ui-components/react/select';\nconst SelectPositioner = Select.Positioner;"
],
"cssVariables": {
"--anchor-height": { "description": "The anchor's height.", "type": "number" },
"--anchor-width": { "description": "The anchor's width.", "type": "number" },
"--available-height": {
"description": "The available height between the trigger and the edge of the viewport.",
"type": "number"
},
"--available-width": {
"description": "The available width between the trigger and the edge of the viewport.",
"type": "number"
},
"--transform-origin": {
"description": "The coordinates that this element is anchored to. Used for animations and transitions.",
"type": "string"
}
},
"classes": [],
"spread": true,
"themeDefaultProps": true,
Expand Down
26 changes: 0 additions & 26 deletions docs/data/api/tab-indicator.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,6 @@
"imports": [
"import { Tabs } from '@base-ui-components/react/tabs';\nconst TabIndicator = Tabs.Indicator;"
],
"cssVariables": {
"--active-tab-bottom": {
"description": "Indicates the distance on the bottom side from the parent's container if the tab is active.",
"type": "number"
},
"--active-tab-height": {
"description": "Indicates the width of the tab if it is active.",
"type": "number"
},
"--active-tab-left": {
"description": "Indicates the distance on the left side from the parent's container if the tab is active.",
"type": "number"
},
"--active-tab-right": {
"description": "Indicates the distance on the right side from the parent's container if the tab is active.",
"type": "number"
},
"--active-tab-top": {
"description": "Indicates the distance on the top side from the parent's container if the tab is active.",
"type": "number"
},
"--active-tab-width": {
"description": "Indicates the width of the tab if it is active.",
"type": "number"
}
},
"classes": [],
"spread": true,
"themeDefaultProps": true,
Expand Down
10 changes: 9 additions & 1 deletion docs/data/api/tooltip-portal.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
{
"props": {},
"props": {
"container": {
"type": {
"name": "union",
"description": "(props, propName) => {\n if (props[propName] == null) {\n return new Error(`Prop '${propName}' is required but wasn't specified`);\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n}<br>&#124;&nbsp;{ current?: (props, propName) => {\n if (props[propName] == null) {\n return null;\n }\n if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {\n return new Error(`Expected prop '${propName}' to be of type Element`);\n }\n return null;\n} }"
}
},
"keepMounted": { "type": { "name": "bool" }, "default": "false" }
},
"name": "TooltipPortal",
"imports": [
"import { Tooltip } from '@base-ui-components/react/tooltip';\nconst TooltipPortal = Tooltip.Portal;"
Expand Down
Loading

0 comments on commit 79a9d79

Please sign in to comment.