react-test/docs/pages/material-ui/api/button.json

{
  "props": {
    "children": { "type": { "name": "node" } },
    "classes": { "type": { "name": "object" }, "additionalInfo": { "cssApi": true } },
    "color": {
      "type": {
        "name": "union",
        "description": "'inherit'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'secondary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'error'<br>&#124;&nbsp;'info'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
      },
      "default": "'primary'"
    },
    "component": { "type": { "name": "elementType" } },
    "disabled": { "type": { "name": "bool" }, "default": "false" },
    "disableElevation": { "type": { "name": "bool" }, "default": "false" },
    "disableFocusRipple": { "type": { "name": "bool" }, "default": "false" },
    "disableRipple": { "type": { "name": "bool" }, "default": "false" },
    "endIcon": { "type": { "name": "node" } },
    "fullWidth": { "type": { "name": "bool" }, "default": "false" },
    "href": { "type": { "name": "string" } },
    "loading": { "type": { "name": "bool" }, "default": "null" },
    "loadingIndicator": {
      "type": { "name": "node" },
      "default": "<CircularProgress color=\"inherit\" size={16} />"
    },
    "loadingPosition": {
      "type": {
        "name": "enum",
        "description": "'center'<br>&#124;&nbsp;'end'<br>&#124;&nbsp;'start'"
      },
      "default": "'center'"
    },
    "size": {
      "type": {
        "name": "union",
        "description": "'small'<br>&#124;&nbsp;'medium'<br>&#124;&nbsp;'large'<br>&#124;&nbsp;string"
      },
      "default": "'medium'"
    },
    "startIcon": { "type": { "name": "node" } },
    "sx": {
      "type": {
        "name": "union",
        "description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
      },
      "additionalInfo": { "sx": true }
    },
    "variant": {
      "type": {
        "name": "union",
        "description": "'contained'<br>&#124;&nbsp;'outlined'<br>&#124;&nbsp;'text'<br>&#124;&nbsp;string"
      },
      "default": "'text'"
    }
  },
  "name": "Button",
  "imports": [
    "import Button from '@mui/material/Button';",
    "import { Button } from '@mui/material';"
  ],
  "classes": [
    {
      "key": "colorError",
      "className": "MuiButton-colorError",
      "description": "Styles applied to the root element if `color=\"error\"`.",
      "isGlobal": false
    },
    {
      "key": "colorInfo",
      "className": "MuiButton-colorInfo",
      "description": "Styles applied to the root element if `color=\"info\"`.",
      "isGlobal": false
    },
    {
      "key": "colorInherit",
      "className": "MuiButton-colorInherit",
      "description": "Styles applied to the root element if `color=\"inherit\"`.",
      "isGlobal": false
    },
    {
      "key": "colorPrimary",
      "className": "MuiButton-colorPrimary",
      "description": "Styles applied to the root element if `color=\"primary\"`.",
      "isGlobal": false
    },
    {
      "key": "colorSecondary",
      "className": "MuiButton-colorSecondary",
      "description": "Styles applied to the root element if `color=\"secondary\"`.",
      "isGlobal": false
    },
    {
      "key": "colorSuccess",
      "className": "MuiButton-colorSuccess",
      "description": "Styles applied to the root element if `color=\"success\"`.",
      "isGlobal": false
    },
    {
      "key": "colorWarning",
      "className": "MuiButton-colorWarning",
      "description": "Styles applied to the root element if `color=\"warning\"`.",
      "isGlobal": false
    },
    {
      "key": "contained",
      "className": "MuiButton-contained",
      "description": "Styles applied to the root element if `variant=\"contained\"`.",
      "isGlobal": false
    },
    {
      "key": "containedError",
      "className": "MuiButton-containedError",
      "description": "Styles applied to the root element if `variant=\"contained\"` and `color=\"error\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "containedInfo",
      "className": "MuiButton-containedInfo",
      "description": "Styles applied to the root element if `variant=\"contained\"` and `color=\"info\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "containedInherit",
      "className": "MuiButton-containedInherit",
      "description": "Styles applied to the root element if `variant=\"contained\"` and `color=\"inherit\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "containedPrimary",
      "className": "MuiButton-containedPrimary",
      "description": "Styles applied to the root element if `variant=\"contained\"` and `color=\"primary\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "containedSecondary",
      "className": "MuiButton-containedSecondary",
      "description": "Styles applied to the root element if `variant=\"contained\"` and `color=\"secondary\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "containedSizeLarge",
      "className": "MuiButton-containedSizeLarge",
      "description": "Styles applied to the root element if `size=\"large\"` and `variant=\"contained\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "containedSizeMedium",
      "className": "MuiButton-containedSizeMedium",
      "description": "Styles applied to the root element if `size=\"medium\"` and `variant=\"contained\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "containedSizeSmall",
      "className": "MuiButton-containedSizeSmall",
      "description": "Styles applied to the root element if `size=\"small\"` and `variant=\"contained\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "containedSuccess",
      "className": "MuiButton-containedSuccess",
      "description": "Styles applied to the root element if `variant=\"contained\"` and `color=\"success\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "containedWarning",
      "className": "MuiButton-containedWarning",
      "description": "Styles applied to the root element if `variant=\"contained\"` and `color=\"warning\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "disabled",
      "className": "Mui-disabled",
      "description": "State class applied to the root element if `disabled={true}`.",
      "isGlobal": true
    },
    {
      "key": "disableElevation",
      "className": "MuiButton-disableElevation",
      "description": "Styles applied to the root element if `disableElevation={true}`.",
      "isGlobal": false
    },
    {
      "key": "endIcon",
      "className": "MuiButton-endIcon",
      "description": "Styles applied to the endIcon element if supplied.",
      "isGlobal": false
    },
    {
      "key": "focusVisible",
      "className": "Mui-focusVisible",
      "description": "State class applied to the ButtonBase root element if the button is keyboard focused.",
      "isGlobal": true
    },
    {
      "key": "fullWidth",
      "className": "MuiButton-fullWidth",
      "description": "Styles applied to the root element if `fullWidth={true}`.",
      "isGlobal": false
    },
    {
      "key": "icon",
      "className": "MuiButton-icon",
      "description": "Styles applied to the icon element if supplied",
      "isGlobal": false
    },
    {
      "key": "iconSizeLarge",
      "className": "MuiButton-iconSizeLarge",
      "description": "Styles applied to the icon element if supplied and `size=\"large\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "iconSizeMedium",
      "className": "MuiButton-iconSizeMedium",
      "description": "Styles applied to the icon element if supplied and `size=\"medium\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "iconSizeSmall",
      "className": "MuiButton-iconSizeSmall",
      "description": "Styles applied to the icon element if supplied and `size=\"small\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "loading",
      "className": "MuiButton-loading",
      "description": "Styles applied to the root element if `loading={true}`.",
      "isGlobal": false
    },
    {
      "key": "loadingIconPlaceholder",
      "className": "MuiButton-loadingIconPlaceholder",
      "description": "Styles applied to the loadingIconPlaceholder element.",
      "isGlobal": false
    },
    {
      "key": "loadingIndicator",
      "className": "MuiButton-loadingIndicator",
      "description": "Styles applied to the loadingIndicator element.",
      "isGlobal": false
    },
    {
      "key": "loadingPositionCenter",
      "className": "MuiButton-loadingPositionCenter",
      "description": "Styles applied to the root element if `loadingPosition=\"center\"`.",
      "isGlobal": false
    },
    {
      "key": "loadingPositionEnd",
      "className": "MuiButton-loadingPositionEnd",
      "description": "Styles applied to the root element if `loadingPosition=\"end\"`.",
      "isGlobal": false
    },
    {
      "key": "loadingPositionStart",
      "className": "MuiButton-loadingPositionStart",
      "description": "Styles applied to the root element if `loadingPosition=\"start\"`.",
      "isGlobal": false
    },
    {
      "key": "loadingWrapper",
      "className": "MuiButton-loadingWrapper",
      "description": "Styles applied to the loadingWrapper element.",
      "isGlobal": false
    },
    {
      "key": "outlined",
      "className": "MuiButton-outlined",
      "description": "Styles applied to the root element if `variant=\"outlined\"`.",
      "isGlobal": false
    },
    {
      "key": "outlinedError",
      "className": "MuiButton-outlinedError",
      "description": "Styles applied to the root element if `variant=\"outlined\"` and `color=\"error\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "outlinedInfo",
      "className": "MuiButton-outlinedInfo",
      "description": "Styles applied to the root element if `variant=\"outlined\"` and `color=\"info\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "outlinedInherit",
      "className": "MuiButton-outlinedInherit",
      "description": "Styles applied to the root element if `variant=\"outlined\"` and `color=\"inherit\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "outlinedPrimary",
      "className": "MuiButton-outlinedPrimary",
      "description": "Styles applied to the root element if `variant=\"outlined\"` and `color=\"primary\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "outlinedSecondary",
      "className": "MuiButton-outlinedSecondary",
      "description": "Styles applied to the root element if `variant=\"outlined\"` and `color=\"secondary\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "outlinedSizeLarge",
      "className": "MuiButton-outlinedSizeLarge",
      "description": "Styles applied to the root element if `size=\"large\"` and `variant=\"outlined\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "outlinedSizeMedium",
      "className": "MuiButton-outlinedSizeMedium",
      "description": "Styles applied to the root element if `size=\"medium\"` and `variant=\"outlined\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "outlinedSizeSmall",
      "className": "MuiButton-outlinedSizeSmall",
      "description": "Styles applied to the root element if `size=\"small\"` and `variant=\"outlined\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "outlinedSuccess",
      "className": "MuiButton-outlinedSuccess",
      "description": "Styles applied to the root element if `variant=\"outlined\"` and `color=\"success\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "outlinedWarning",
      "className": "MuiButton-outlinedWarning",
      "description": "Styles applied to the root element if `variant=\"outlined\"` and `color=\"warning\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "root",
      "className": "MuiButton-root",
      "description": "Styles applied to the root element.",
      "isGlobal": false
    },
    {
      "key": "sizeLarge",
      "className": "MuiButton-sizeLarge",
      "description": "Styles applied to the root element if `size=\"large\"`.",
      "isGlobal": false
    },
    {
      "key": "sizeMedium",
      "className": "MuiButton-sizeMedium",
      "description": "Styles applied to the root element if `size=\"medium\"`.",
      "isGlobal": false
    },
    {
      "key": "sizeSmall",
      "className": "MuiButton-sizeSmall",
      "description": "Styles applied to the root element if `size=\"small\"`.",
      "isGlobal": false
    },
    {
      "key": "startIcon",
      "className": "MuiButton-startIcon",
      "description": "Styles applied to the startIcon element if supplied.",
      "isGlobal": false
    },
    {
      "key": "text",
      "className": "MuiButton-text",
      "description": "Styles applied to the root element if `variant=\"text\"`.",
      "isGlobal": false
    },
    {
      "key": "textError",
      "className": "MuiButton-textError",
      "description": "Styles applied to the root element if `variant=\"text\"` and `color=\"error\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "textInfo",
      "className": "MuiButton-textInfo",
      "description": "Styles applied to the root element if `variant=\"text\"` and `color=\"info\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "textInherit",
      "className": "MuiButton-textInherit",
      "description": "Styles applied to the root element if `variant=\"text\"` and `color=\"inherit\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "textPrimary",
      "className": "MuiButton-textPrimary",
      "description": "Styles applied to the root element if `variant=\"text\"` and `color=\"primary\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "textSecondary",
      "className": "MuiButton-textSecondary",
      "description": "Styles applied to the root element if `variant=\"text\"` and `color=\"secondary\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "textSizeLarge",
      "className": "MuiButton-textSizeLarge",
      "description": "Styles applied to the root element if `size=\"large\"` and `variant=\"text\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "textSizeMedium",
      "className": "MuiButton-textSizeMedium",
      "description": "Styles applied to the root element if `size=\"medium\"` and `variant=\"text\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "textSizeSmall",
      "className": "MuiButton-textSizeSmall",
      "description": "Styles applied to the root element if `size=\"small\"` and `variant=\"text\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "textSuccess",
      "className": "MuiButton-textSuccess",
      "description": "Styles applied to the root element if `variant=\"text\"` and `color=\"success\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "textWarning",
      "className": "MuiButton-textWarning",
      "description": "Styles applied to the root element if `variant=\"text\"` and `color=\"warning\"`.",
      "isGlobal": false,
      "isDeprecated": true
    }
  ],
  "spread": true,
  "themeDefaultProps": true,
  "muiName": "MuiButton",
  "forwardsRefTo": "HTMLButtonElement",
  "filename": "/packages/mui-material/src/Button/Button.js",
  "inheritance": { "component": "ButtonBase", "pathname": "/material-ui/api/button-base/" },
  "demos": "<ul><li><a href=\"/material-ui/react-button-group/\">Button Group</a></li>\n<li><a href=\"/material-ui/react-button/\">Button</a></li>\n<li><a href=\"/material-ui/react-number-field/\">Number Field</a></li></ul>",
  "cssComponent": false
}