Skip to content

Commit

Permalink
Merge branch 'master' into fix/Popover-openOnHover
Browse files Browse the repository at this point in the history
  • Loading branch information
atomiks authored Nov 20, 2024
2 parents cb51791 + 9b63f1b commit fcf97a6
Show file tree
Hide file tree
Showing 67 changed files with 1,210 additions and 78 deletions.
2 changes: 1 addition & 1 deletion docs/data/api/alert-dialog-root.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"props": {
"animated": { "type": { "name": "bool" }, "default": "true" },
"defaultOpen": { "type": { "name": "bool" } },
"defaultOpen": { "type": { "name": "bool" }, "default": "false" },
"onOpenChange": { "type": { "name": "func" } },
"open": { "type": { "name": "bool" } }
},
Expand Down
2 changes: 1 addition & 1 deletion docs/data/api/dialog-root.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"props": {
"animated": { "type": { "name": "bool" }, "default": "true" },
"defaultOpen": { "type": { "name": "bool" } },
"defaultOpen": { "type": { "name": "bool" }, "default": "false" },
"dismissible": { "type": { "name": "bool" }, "default": "true" },
"modal": { "type": { "name": "bool" }, "default": "true" },
"onOpenChange": { "type": { "name": "func" } },
Expand Down
3 changes: 3 additions & 0 deletions docs/data/api/menu-checkbox-item.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
{
"props": {
"checked": { "type": { "name": "bool" } },
"closeOnClick": { "type": { "name": "bool" }, "default": "true" },
"defaultChecked": { "type": { "name": "bool" }, "default": "false" },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"id": { "type": { "name": "string" } },
"label": { "type": { "name": "string" } },
"onCheckedChange": { "type": { "name": "func" } },
"onClick": { "type": { "name": "func" } }
},
"name": "MenuCheckboxItem",
Expand Down
3 changes: 3 additions & 0 deletions docs/data/api/select-trigger.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@
"import { Select } from '@base_ui/react/Select';\nconst SelectTrigger = Select.Trigger;"
],
"classes": [],
"spread": true,
"themeDefaultProps": true,
"muiName": "SelectTrigger",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-base/src/Select/Trigger/SelectTrigger.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/components/react-select/\">Select</a></li></ul>",
Expand Down
4 changes: 2 additions & 2 deletions docs/data/api/slider-root.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
"onValueChange": {
"type": { "name": "func" },
"signature": {
"type": "function(value: number | Array<number>, activeThumb: number, event: Event) => void",
"describedArgs": ["value", "activeThumb", "event"]
"type": "function(value: number | Array<number>, event: Event, activeThumbIndex: number) => void",
"describedArgs": ["value", "event", "activeThumbIndex"]
}
},
"onValueCommitted": {
Expand Down
2 changes: 1 addition & 1 deletion docs/data/api/switch-root.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"props": {
"checked": { "type": { "name": "bool" } },
"className": { "type": { "name": "union", "description": "func<br>&#124;&nbsp;string" } },
"defaultChecked": { "type": { "name": "bool" } },
"defaultChecked": { "type": { "name": "bool" }, "default": "false" },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"inputRef": { "type": { "name": "custom", "description": "ref" } },
"name": { "type": { "name": "string" } },
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
{
"componentDescription": "An unstyled checkbox menu item to be used within a Menu.",
"propDescriptions": {
"checked": { "description": "If <code>true</code>, the checkbox is checked." },
"closeOnClick": {
"description": "If <code>true</code>, the menu will close when the menu item is clicked."
},
"defaultChecked": {
"description": "The default checked state. Use when the component is uncontrolled."
},
"disabled": { "description": "If <code>true</code>, the menu item will be disabled." },
"id": { "description": "The id of the menu item." },
"label": {
"description": "A text representation of the menu item&#39;s content. Used for keyboard text navigation matching."
},
"onCheckedChange": { "description": "Callback fired when the checked state is changed." },
"onClick": { "description": "The click handler for the menu item." }
},
"classDescriptions": {}
Expand Down
4 changes: 2 additions & 2 deletions docs/data/translations/api-docs/slider-root/slider-root.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
"description": "Callback function that is fired when the slider&#39;s value changed.",
"typeDescriptions": {
"value": "The new value.",
"activeThumb": "Index of the currently moved thumb.",
"event": "The event source of the callback. You can pull out the new value by accessing <code>event.target.value</code> (any). <strong>Warning</strong>: This is a generic event not a change event."
"event": "The event source of the callback. You can pull out the new value by accessing <code>event.target.value</code> (any).",
"activeThumbIndex": "Index of the currently moved thumb."
}
},
"onValueCommitted": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"description": "Class names applied to the element or a function that returns them based on the component&#39;s state."
},
"defaultChecked": {
"description": "The default checked state. Use when the component is not controlled."
"description": "The default checked state. Use when the component is uncontrolled."
},
"disabled": {
"description": "If <code>true</code>, the component is disabled and can&#39;t be interacted with."
Expand Down
1 change: 1 addition & 0 deletions docs/reference/generated/alert-dialog-root.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
},
"defaultOpen": {
"type": "boolean",
"default": "false",
"description": "Determines whether the dialog is initally open.\nThis is an uncontrolled equivalent of the `open` prop."
},
"onOpenChange": {
Expand Down
1 change: 1 addition & 0 deletions docs/reference/generated/dialog-root.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
},
"defaultOpen": {
"type": "boolean",
"default": "false",
"description": "Determines whether the dialog is initally open.\nThis is an uncontrolled equivalent of the `open` prop."
},
"dismissible": {
Expand Down
13 changes: 13 additions & 0 deletions docs/reference/generated/menu-checkbox-item.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,20 @@
"name": "MenuCheckboxItem",
"description": "An unstyled checkbox menu item to be used within a Menu.",
"props": {
"checked": {
"type": "boolean",
"description": "If `true`, the checkbox is checked."
},
"closeOnClick": {
"type": "boolean",
"default": "true",
"description": "If `true`, the menu will close when the menu item is clicked."
},
"defaultChecked": {
"type": "boolean",
"default": "false",
"description": "The default checked state. Use when the component is uncontrolled."
},
"disabled": {
"type": "boolean",
"default": "false",
Expand All @@ -20,6 +29,10 @@
"type": "string",
"description": "A text representation of the menu item's content.\nUsed for keyboard text navigation matching."
},
"onCheckedChange": {
"type": "function",
"description": "Callback fired when the checked state is changed."
},
"onClick": {
"type": "(event) => void",
"description": "The click handler for the menu item."
Expand Down
19 changes: 19 additions & 0 deletions docs/reference/generated/select-arrow.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "SelectArrow",
"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."
},
"hideWhenUncentered": {
"type": "boolean",
"default": "false",
"description": "If `true`, the arrow is hidden when it can't point to the center of the anchor element."
},
"render": {
"type": "React.ReactElement | (props, state) => React.ReactElement",
"description": "A function to customize rendering of the component."
}
}
}
24 changes: 24 additions & 0 deletions docs/reference/generated/select-backdrop.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"name": "SelectBackdrop",
"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",
"default": "false",
"description": "The container element to which the Backdrop is appended to."
},
"keepMounted": {
"type": "boolean",
"default": "false",
"description": "If `true`, the Backdrop remains mounted when the Select popup is 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/select-group-label.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"name": "SelectGroupLabel",
"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/select-group.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"name": "SelectGroup",
"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/select-icon.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"name": "SelectIcon",
"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/select-option-indicator.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "SelectOptionIndicator",
"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 item indicator remains mounted when the item is not\nselected."
},
"render": {
"type": "React.ReactElement | (props, state) => React.ReactElement",
"description": "A function to customize rendering of the component."
}
}
}
5 changes: 5 additions & 0 deletions docs/reference/generated/select-option-text.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"name": "SelectOptionText",
"description": "",
"props": {}
}
20 changes: 20 additions & 0 deletions docs/reference/generated/select-option.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"name": "SelectOption",
"description": "",
"props": {
"disabled": {
"type": "boolean",
"default": "false",
"description": "If `true`, the select option will be disabled."
},
"label": {
"type": "string",
"description": "A text representation of the select option's content.\nUsed for keyboard text navigation matching."
},
"value": {
"type": "any",
"default": "null",
"description": "The value of the select option."
}
}
}
18 changes: 18 additions & 0 deletions docs/reference/generated/select-popup.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"name": "SelectPopup",
"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."
},
"id": {
"type": "string",
"description": "The id of the popup element."
},
"render": {
"type": "React.ReactElement | (props, state) => React.ReactElement",
"description": "A function to customize rendering of the component."
}
}
}
77 changes: 77 additions & 0 deletions docs/reference/generated/select-positioner.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
{
"name": "SelectPositioner",
"description": "",
"props": {
"alignment": {
"type": "'start' | 'center' | 'end'",
"default": "'start'",
"description": "The alignment of the Select element to the anchor element along its cross axis."
},
"alignmentOffset": {
"type": "number",
"default": "0",
"description": "The offset of the Select element along its alignment axis."
},
"anchor": {
"type": "React.Ref | Element | VirtualElement | (() => Element | VirtualElement | null) | null",
"description": "The anchor element to which the Select popup will be placed at."
},
"arrowPadding": {
"type": "number",
"default": "5",
"description": "Determines the padding between the arrow and the Select popup's edges. Useful when the popover\npopup has rounded corners via `border-radius`."
},
"className": {
"type": "string | (state) => string",
"description": "Class names applied to the element or a function that returns them based on the component's state."
},
"collisionBoundary": {
"type": "'clippingAncestors' | Element | Element[] | Rect",
"default": "'clippingAncestors'",
"description": "The boundary that the Select element should be constrained to."
},
"collisionPadding": {
"type": "number | Rect",
"default": "5",
"description": "The padding of the collision boundary."
},
"container": {
"type": "React.Ref | HTMLElement | null",
"description": "The container element to which the Select popup will be appended to."
},
"hideWhenDetached": {
"type": "boolean",
"default": "false",
"description": "If `true`, the Select will be hidden if it is detached from its anchor element due to\ndiffering clipping contexts."
},
"positionMethod": {
"type": "'absolute' | 'fixed'",
"default": "'absolute'",
"description": "The CSS position method for positioning the Select popup element."
},
"render": {
"type": "React.ReactElement | (props, state) => React.ReactElement",
"description": "A function to customize rendering of the component."
},
"side": {
"type": "'top' | 'bottom' | 'left' | 'right'",
"default": "'bottom'",
"description": "The side of the anchor element that the Select element should align to."
},
"sideOffset": {
"type": "number",
"default": "0",
"description": "The gap between the anchor element and the Select element."
},
"sticky": {
"type": "boolean",
"default": "false",
"description": "If `true`, allow the Select to remain in stuck view while the anchor element is scrolled out\nof view."
},
"trackAnchor": {
"type": "boolean",
"default": "true",
"description": "Whether the select popup continuously tracks its anchor after the initial positioning upon mount."
}
}
}
Loading

0 comments on commit fcf97a6

Please sign in to comment.