Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs-infra] Simplify CSS classes extraction in API docs generator #39808

Merged
merged 10 commits into from
Nov 30, 2023
  •  
  •  
  •  
14 changes: 10 additions & 4 deletions docs/pages/base-ui/api/badge.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,28 @@
},
"name": "Badge",
"imports": ["import { Badge } from '@mui/base/Badge';", "import { Badge } from '@mui/base';"],
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'span'",
"class": ".MuiBadge-root"
"class": "MuiBadge-root"
},
{
"name": "badge",
"description": "The component that renders the badge.",
"default": "'span'",
"class": ".MuiBadge-badge"
"class": "MuiBadge-badge"
}
],
"classes": [
{
"key": "invisible",
"className": "MuiBadge-invisible",
"description": "State class applied to the badge `span` element if `invisible={true}`.",
"isGlobal": false
}
],
"classes": { "classes": ["invisible"], "globalClasses": {} },
"spread": true,
"muiName": "MuiBadge",
"forwardsRefTo": "HTMLSpanElement",
Expand Down
29 changes: 20 additions & 9 deletions docs/pages/base-ui/api/button.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,34 @@
},
"name": "Button",
"imports": ["import { Button } from '@mui/base/Button';", "import { Button } from '@mui/base';"],
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "props.href || props.to ? 'a' : 'button'",
"class": ".MuiButton-root"
"class": "MuiButton-root"
}
],
"classes": {
"classes": ["active", "disabled", "focusVisible"],
"globalClasses": {
"active": "Mui-active",
"disabled": "Mui-disabled",
"focusVisible": "Mui-focusVisible"
"classes": [
{
"key": "active",
"className": "Mui-active",
"description": "State class applied to the root `button` element if `active={true}`.",
"isGlobal": true
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root `button` element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "State class applied to the root `button` element if `focusVisible={true}`.",
"isGlobal": true
}
},
],
"spread": true,
"muiName": "MuiButton",
"forwardsRefTo": "HTMLButtonElement",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/click-away-listener.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"import { ClickAwayListener } from '@mui/base/ClickAwayListener';",
"import { ClickAwayListener } from '@mui/base';"
],
"styles": { "classes": [], "globalClasses": {}, "name": null },
"classes": [],
"spread": false,
"themeDefaultProps": null,
"muiName": "MuiClickAwayListener",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/dropdown.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"import { Dropdown } from '@mui/base/Dropdown';",
"import { Dropdown } from '@mui/base';"
],
"styles": { "classes": [], "globalClasses": {}, "name": null },
"classes": [],
"spread": false,
"themeDefaultProps": null,
"muiName": "MuiDropdown",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/focus-trap.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"import { FocusTrap } from '@mui/base/FocusTrap';",
"import { FocusTrap } from '@mui/base';"
],
"styles": { "classes": [], "globalClasses": {}, "name": null },
"classes": [],
"spread": false,
"themeDefaultProps": null,
"muiName": "MuiFocusTrap",
Expand Down
46 changes: 37 additions & 9 deletions docs/pages/base-ui/api/form-control.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,44 @@
"import { FormControl } from '@mui/base/FormControl';",
"import { FormControl } from '@mui/base';"
],
"styles": {
"classes": ["root", "disabled", "error", "filled", "focused", "required"],
"globalClasses": {
"disabled": "Mui-disabled",
"error": "Mui-error",
"focused": "Mui-focused",
"required": "Mui-required"
"classes": [
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
"name": null
},
{
"key": "error",
"className": "Mui-error",
"description": "State class applied to the root element if `error={true}`.",
"isGlobal": true
},
{
"key": "filled",
"className": "MuiFormControl-filled",
"description": "State class applied to the root element if the inner input has value.",
"isGlobal": false
},
{
"key": "focused",
"className": "Mui-focused",
"description": "State class applied to the root element if the inner input is focused.",
"isGlobal": true
},
{
"key": "required",
"className": "Mui-required",
"description": "State class applied to the root element if `required={true}`.",
"isGlobal": true
},
{
"key": "root",
"className": "MuiFormControl-root",
"description": "Class applied to the root element.",
"isGlobal": false
}
],
"spread": true,
"muiName": "MuiFormControl",
"forwardsRefTo": "HTMLDivElement",
Expand Down
75 changes: 58 additions & 17 deletions docs/pages/base-ui/api/input.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,19 +43,18 @@
},
"name": "Input",
"imports": ["import { Input } from '@mui/base/Input';", "import { Input } from '@mui/base';"],
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": ".MuiInput-root"
"class": "MuiInput-root"
},
{
"name": "input",
"description": "The component that renders the input.",
"default": "'input'",
"class": ".MuiInput-input"
"class": "MuiInput-input"
},
{
"name": "textarea",
Expand All @@ -64,20 +63,62 @@
"class": null
}
],
"classes": {
"classes": [
"adornedEnd",
"adornedStart",
"disabled",
"error",
"focused",
"formControl",
"inputMultiline",
"inputTypeSearch",
"multiline"
],
"globalClasses": { "focused": "Mui-focused", "disabled": "Mui-disabled", "error": "Mui-error" }
},
"classes": [
{
"key": "adornedEnd",
"className": "MuiInput-adornedEnd",
"description": "Class name applied to the root element if `endAdornment` is provided.",
"isGlobal": false
},
{
"key": "adornedStart",
"className": "MuiInput-adornedStart",
"description": "Class name applied to the root element if `startAdornment` is provided.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "error",
"className": "Mui-error",
"description": "State class applied to the root element if `error={true}`.",
"isGlobal": true
},
{
"key": "focused",
"className": "Mui-focused",
"description": "State class applied to the root element if the component is focused.",
"isGlobal": true
},
{
"key": "formControl",
"className": "MuiInput-formControl",
"description": "Class name applied to the root element if the component is a descendant of `FormControl`.",
"isGlobal": false
},
{
"key": "inputMultiline",
"className": "MuiInput-inputMultiline",
"description": "Class name applied to the input element if `multiline={true}`.",
"isGlobal": false
},
{
"key": "inputTypeSearch",
"className": "MuiInput-inputTypeSearch",
"description": "Class name applied to the input element if `type=\"search\"`.",
"isGlobal": false
},
{
"key": "multiline",
"className": "MuiInput-multiline",
"description": "Class name applied to the root element if `multiline={true}`.",
"isGlobal": false
}
],
"spread": true,
"muiName": "MuiInput",
"forwardsRefTo": "HTMLDivElement",
Expand Down
29 changes: 20 additions & 9 deletions docs/pages/base-ui/api/menu-button.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,34 @@
"import { MenuButton } from '@mui/base/MenuButton';",
"import { MenuButton } from '@mui/base';"
],
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'button'",
"class": ".MuiMenuButton-root"
"class": "MuiMenuButton-root"
}
],
"classes": {
"classes": ["active", "disabled", "expanded"],
"globalClasses": {
"active": "Mui-active",
"disabled": "Mui-disabled",
"expanded": "Mui-expanded"
"classes": [
{
"key": "active",
"className": "Mui-active",
"description": "State class applied to the root element if `active={true}`.",
"isGlobal": true
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "expanded",
"className": "Mui-expanded",
"description": "State class applied to the root element if the associated menu is open.",
"isGlobal": true
}
},
],
"spread": true,
"muiName": "MuiMenuButton",
"forwardsRefTo": "HTMLButtonElement",
Expand Down
21 changes: 15 additions & 6 deletions docs/pages/base-ui/api/menu-item.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,28 @@
"import { MenuItem } from '@mui/base/MenuItem';",
"import { MenuItem } from '@mui/base';"
],
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'li'",
"class": ".MuiMenuItem-root"
"class": "MuiMenuItem-root"
}
],
"classes": [
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root `button` element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "State class applied to the root `button` element if `focusVisible={true}`.",
"isGlobal": true
}
],
"classes": {
"classes": ["disabled", "focusVisible"],
"globalClasses": { "disabled": "Mui-disabled", "focusVisible": "Mui-focusVisible" }
},
"spread": true,
"muiName": "MuiMenuItem",
"forwardsRefTo": "HTMLLIElement",
Expand Down
14 changes: 10 additions & 4 deletions docs/pages/base-ui/api/menu.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,28 @@
},
"name": "Menu",
"imports": ["import { Menu } from '@mui/base/Menu';", "import { Menu } from '@mui/base';"],
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "root",
"description": "The component that renders the popup element.",
"default": "'div'",
"class": ".MuiMenu-root"
"class": "MuiMenu-root"
},
{
"name": "listbox",
"description": "The component that renders the listbox.",
"default": "'ul'",
"class": ".MuiMenu-listbox"
"class": "MuiMenu-listbox"
}
],
"classes": [
{
"key": "expanded",
"className": "Mui-expanded",
"description": "State class applied to the root element if `open={true}`.",
"isGlobal": true
}
],
"classes": { "classes": ["expanded"], "globalClasses": { "expanded": "Mui-expanded" } },
"spread": true,
"muiName": "MuiMenu",
"forwardsRefTo": "HTMLDivElement",
Expand Down
Loading