Skip to content

Commit

Permalink
[core] Fix paths in API docs builder (#180)
Browse files Browse the repository at this point in the history
  • Loading branch information
michaldudak authored Mar 13, 2024
1 parent 1af879e commit e786f03
Show file tree
Hide file tree
Showing 51 changed files with 83 additions and 1,212 deletions.
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"@mui/joy": "5.0.0-beta.28",
"@mui/material": "^5.15.10",
"@mui/material-nextjs": "^5.15.9",
"@mui/monorepo": "github:mui/material-ui#5e4e18a10085b7e65955ca11ba6c93c838003e0c",
"@mui/monorepo": "github:mui/material-ui#ad3a9364756881fef41bf01723a886ea1a823b0d",
"@mui/styles": "^5.15.9",
"@mui/system": "^5.15.9",
"@mui/types": "^7.2.13",
Expand Down
23 changes: 1 addition & 22 deletions docs/pages/base-ui/api/badge.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,7 @@
},
"name": "Badge",
"imports": ["import { Badge } from '@mui/base/Badge';", "import { Badge } from '@mui/base';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'span'",
"class": "base-Badge-root"
},
{
"name": "badge",
"description": "The component that renders the badge.",
"default": "'span'",
"class": "base-Badge-badge"
}
],
"classes": [
{
"key": "invisible",
"className": "base-Badge-invisible",
"description": "State class applied to the badge `span` element if `invisible={true}`.",
"isGlobal": false
}
],
"classes": [],
"spread": true,
"muiName": "Badge",
"forwardsRefTo": "HTMLSpanElement",
Expand Down
29 changes: 1 addition & 28 deletions docs/pages/base-ui/api/button.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,7 @@
},
"name": "Button",
"imports": ["import { Button } from '@mui/base/Button';", "import { Button } from '@mui/base';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "props.href || props.to ? 'a' : 'button'",
"class": "base-Button-root"
}
],
"classes": [
{
"key": "active",
"className": "base--active",
"description": "State class applied to the root `button` element if `active={true}`.",
"isGlobal": true
},
{
"key": "disabled",
"className": "base--disabled",
"description": "State class applied to the root `button` element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "base--focusVisible",
"description": "State class applied to the root `button` element if `focusVisible={true}`.",
"isGlobal": true
}
],
"classes": [],
"spread": true,
"muiName": "Button",
"forwardsRefTo": "HTMLButtonElement",
Expand Down
39 changes: 1 addition & 38 deletions docs/pages/base-ui/api/form-control.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,44 +22,7 @@
"import { FormControl } from '@mui/base/FormControl';",
"import { FormControl } from '@mui/base';"
],
"classes": [
{
"key": "disabled",
"className": "base--disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "error",
"className": "base--error",
"description": "State class applied to the root element if `error={true}`.",
"isGlobal": true
},
{
"key": "filled",
"className": "base-FormControl-filled",
"description": "State class applied to the root element if the inner input has value.",
"isGlobal": false
},
{
"key": "focused",
"className": "base--focused",
"description": "State class applied to the root element if the inner input is focused.",
"isGlobal": true
},
{
"key": "required",
"className": "base--required",
"description": "State class applied to the root element if `required={true}`.",
"isGlobal": true
},
{
"key": "root",
"className": "base-FormControl-root",
"description": "Class applied to the root element.",
"isGlobal": false
}
],
"classes": [],
"spread": true,
"muiName": "FormControl",
"forwardsRefTo": "HTMLDivElement",
Expand Down
77 changes: 1 addition & 76 deletions docs/pages/base-ui/api/input.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,82 +43,7 @@
},
"name": "Input",
"imports": ["import { Input } from '@mui/base/Input';", "import { Input } from '@mui/base';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "base-Input-root"
},
{
"name": "input",
"description": "The component that renders the input.",
"default": "'input'",
"class": "base-Input-input"
},
{
"name": "textarea",
"description": "The component that renders the textarea.",
"default": "'textarea'",
"class": null
}
],
"classes": [
{
"key": "adornedEnd",
"className": "base-Input-adornedEnd",
"description": "Class name applied to the root element if `endAdornment` is provided.",
"isGlobal": false
},
{
"key": "adornedStart",
"className": "base-Input-adornedStart",
"description": "Class name applied to the root element if `startAdornment` is provided.",
"isGlobal": false
},
{
"key": "disabled",
"className": "base--disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "error",
"className": "base--error",
"description": "State class applied to the root element if `error={true}`.",
"isGlobal": true
},
{
"key": "focused",
"className": "base--focused",
"description": "State class applied to the root element if the component is focused.",
"isGlobal": true
},
{
"key": "formControl",
"className": "base-Input-formControl",
"description": "Class name applied to the root element if the component is a descendant of `FormControl`.",
"isGlobal": false
},
{
"key": "inputMultiline",
"className": "base-Input-inputMultiline",
"description": "Class name applied to the input element if `multiline={true}`.",
"isGlobal": false
},
{
"key": "inputTypeSearch",
"className": "base-Input-inputTypeSearch",
"description": "Class name applied to the input element if `type=\"search\"`.",
"isGlobal": false
},
{
"key": "multiline",
"className": "base-Input-multiline",
"description": "Class name applied to the root element if `multiline={true}`.",
"isGlobal": false
}
],
"classes": [],
"spread": true,
"muiName": "Input",
"forwardsRefTo": "HTMLDivElement",
Expand Down
29 changes: 1 addition & 28 deletions docs/pages/base-ui/api/menu-button.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,34 +19,7 @@
"import { MenuButton } from '@mui/base/MenuButton';",
"import { MenuButton } from '@mui/base';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'button'",
"class": "base-MenuButton-root"
}
],
"classes": [
{
"key": "active",
"className": "base--active",
"description": "State class applied to the root element if `active={true}`.",
"isGlobal": true
},
{
"key": "disabled",
"className": "base--disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "expanded",
"className": "base--expanded",
"description": "State class applied to the root element if the associated menu is open.",
"isGlobal": true
}
],
"classes": [],
"spread": true,
"muiName": "MenuButton",
"forwardsRefTo": "HTMLButtonElement",
Expand Down
23 changes: 1 addition & 22 deletions docs/pages/base-ui/api/menu-item.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,28 +18,7 @@
"import { MenuItem } from '@mui/base/MenuItem';",
"import { MenuItem } from '@mui/base';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'li'",
"class": "base-MenuItem-root"
}
],
"classes": [
{
"key": "disabled",
"className": "base--disabled",
"description": "State class applied to the root `button` element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "base--focusVisible",
"description": "State class applied to the root `button` element if `focusVisible={true}`.",
"isGlobal": true
}
],
"classes": [],
"spread": true,
"muiName": "MenuItem",
"forwardsRefTo": "HTMLLIElement",
Expand Down
23 changes: 1 addition & 22 deletions docs/pages/base-ui/api/menu.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,28 +23,7 @@
},
"name": "Menu",
"imports": ["import { Menu } from '@mui/base/Menu';", "import { Menu } from '@mui/base';"],
"slots": [
{
"name": "root",
"description": "The component that renders the popup element.",
"default": "'div'",
"class": "base-Menu-root"
},
{
"name": "listbox",
"description": "The component that renders the listbox.",
"default": "'ul'",
"class": "base-Menu-listbox"
}
],
"classes": [
{
"key": "expanded",
"className": "base--expanded",
"description": "State class applied to the root element if `open={true}`.",
"isGlobal": true
}
],
"classes": [],
"spread": true,
"muiName": "Menu",
"forwardsRefTo": "HTMLDivElement",
Expand Down
22 changes: 1 addition & 21 deletions docs/pages/base-ui/api/modal.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,27 +41,7 @@
},
"name": "Modal",
"imports": ["import { Modal } from '@mui/base/Modal';", "import { Modal } from '@mui/base';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "base-Modal-root"
},
{
"name": "backdrop",
"description": "The component that renders the backdrop.",
"class": "base-Modal-backdrop"
}
],
"classes": [
{
"key": "hidden",
"className": "base-Modal-hidden",
"description": "Class name applied to the root element if the `Modal` has exited.",
"isGlobal": false
}
],
"classes": [],
"spread": true,
"muiName": "Modal",
"forwardsRefTo": "HTMLDivElement",
Expand Down
Loading

0 comments on commit e786f03

Please sign in to comment.