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

{
  "props": {
    "action": {
      "type": {
        "name": "union",
        "description": "func<br>&#124;&nbsp;{ current?: { focusVisible: func } }"
      }
    },
    "color": {
      "type": {
        "name": "union",
        "description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
      },
      "default": "'primary'",
      "additionalInfo": { "joy-color": true }
    },
    "component": { "type": { "name": "elementType" } },
    "disabled": { "type": { "name": "bool" }, "default": "false" },
    "endDecorator": { "type": { "name": "node" } },
    "fullWidth": { "type": { "name": "bool" }, "default": "false" },
    "loading": { "type": { "name": "bool" }, "default": "false" },
    "loadingIndicator": { "type": { "name": "node" }, "default": "<CircularProgress />" },
    "loadingPosition": {
      "type": {
        "name": "enum",
        "description": "'center'<br>&#124;&nbsp;'end'<br>&#124;&nbsp;'start'"
      },
      "default": "'center'"
    },
    "size": {
      "type": {
        "name": "union",
        "description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
      },
      "default": "'md'",
      "additionalInfo": { "joy-size": true }
    },
    "slotProps": {
      "type": {
        "name": "shape",
        "description": "{ endDecorator?: func<br>&#124;&nbsp;object, loadingIndicatorCenter?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object, startDecorator?: func<br>&#124;&nbsp;object }"
      },
      "default": "{}"
    },
    "slots": {
      "type": {
        "name": "shape",
        "description": "{ endDecorator?: elementType, loadingIndicatorCenter?: elementType, root?: elementType, startDecorator?: elementType }"
      },
      "default": "{}",
      "additionalInfo": { "slotsApi": true }
    },
    "startDecorator": { "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": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
      },
      "default": "'solid'",
      "additionalInfo": { "joy-variant": true }
    }
  },
  "name": "Button",
  "imports": ["import Button from '@mui/joy/Button';", "import { Button } from '@mui/joy';"],
  "slots": [
    {
      "name": "root",
      "description": "The component that renders the root.",
      "default": "'button'",
      "class": "MuiButton-root"
    },
    {
      "name": "startDecorator",
      "description": "The component that renders the start decorator.",
      "default": "'span'",
      "class": "MuiButton-startDecorator"
    },
    {
      "name": "endDecorator",
      "description": "The component that renders the end decorator.",
      "default": "'span'",
      "class": "MuiButton-endDecorator"
    },
    {
      "name": "loadingIndicatorCenter",
      "description": "The component that renders the loading indicator center.",
      "default": "'span'",
      "class": "MuiButton-loadingIndicatorCenter"
    }
  ],
  "classes": [
    {
      "key": "colorContext",
      "className": "MuiButton-colorContext",
      "description": "Class name applied to the root element when color inversion is triggered.",
      "isGlobal": false
    },
    {
      "key": "colorDanger",
      "className": "MuiButton-colorDanger",
      "description": "Class name applied to the root element if `color=\"danger\"`.",
      "isGlobal": false
    },
    {
      "key": "colorNeutral",
      "className": "MuiButton-colorNeutral",
      "description": "Class name applied to the root element if `color=\"neutral\"`.",
      "isGlobal": false
    },
    {
      "key": "colorPrimary",
      "className": "MuiButton-colorPrimary",
      "description": "Class name applied to the root element if `color=\"primary\"`.",
      "isGlobal": false
    },
    {
      "key": "colorSuccess",
      "className": "MuiButton-colorSuccess",
      "description": "Class name applied to the root element if `color=\"success\"`.",
      "isGlobal": false
    },
    {
      "key": "colorWarning",
      "className": "MuiButton-colorWarning",
      "description": "Class name applied to the root element if `color=\"warning\"`.",
      "isGlobal": false
    },
    {
      "key": "disabled",
      "className": "Mui-disabled",
      "description": "State class applied to the root element if `disabled={true}`.",
      "isGlobal": true
    },
    {
      "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": "Class name applied to the root element if `fullWidth={true}`.",
      "isGlobal": false
    },
    {
      "key": "loading",
      "className": "MuiButton-loading",
      "description": "Class name applied to the root element if `loading={true}`.",
      "isGlobal": false
    },
    {
      "key": "sizeLg",
      "className": "MuiButton-sizeLg",
      "description": "Class name applied to the root element if `size=\"lg\"`.",
      "isGlobal": false
    },
    {
      "key": "sizeMd",
      "className": "MuiButton-sizeMd",
      "description": "Class name applied to the root element if `size=\"md\"`.",
      "isGlobal": false
    },
    {
      "key": "sizeSm",
      "className": "MuiButton-sizeSm",
      "description": "Class name applied to the root element if `size=\"sm\"`.",
      "isGlobal": false
    },
    {
      "key": "variantOutlined",
      "className": "MuiButton-variantOutlined",
      "description": "Class name applied to the root element if `variant=\"outlined\"`.",
      "isGlobal": false
    },
    {
      "key": "variantPlain",
      "className": "MuiButton-variantPlain",
      "description": "Class name applied to the root element if `variant=\"plain\"`.",
      "isGlobal": false
    },
    {
      "key": "variantSoft",
      "className": "MuiButton-variantSoft",
      "description": "Class name applied to the root element if `variant=\"soft\"`.",
      "isGlobal": false
    },
    {
      "key": "variantSolid",
      "className": "MuiButton-variantSolid",
      "description": "Class name applied to the root element if `variant=\"solid\"`.",
      "isGlobal": false
    }
  ],
  "spread": false,
  "themeDefaultProps": true,
  "muiName": "JoyButton",
  "forwardsRefTo": "HTMLButtonElement",
  "filename": "/packages/mui-joy/src/Button/Button.tsx",
  "inheritance": null,
  "demos": "<ul><li><a href=\"/joy-ui/react-button/\">Button</a></li>\n<li><a href=\"/joy-ui/react-button-group/\">Button Group</a></li>\n<li><a href=\"/joy-ui/react-toggle-button-group/\">Toggle Button Group</a></li></ul>",
  "cssComponent": false
}