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

{
  "props": {
    "action": { "type": { "name": "node" } },
    "children": { "type": { "name": "node" } },
    "classes": { "type": { "name": "object" }, "additionalInfo": { "cssApi": true } },
    "closeText": { "type": { "name": "string" }, "default": "'Close'" },
    "color": {
      "type": {
        "name": "union",
        "description": "'error'<br>&#124;&nbsp;'info'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
      }
    },
    "components": {
      "type": {
        "name": "shape",
        "description": "{ CloseButton?: elementType, CloseIcon?: elementType }"
      },
      "default": "{}",
      "deprecated": true,
      "deprecationInfo": "use the <code>slots</code> prop instead. This prop will be removed in a future major release. See <a href=\"https://mui.com/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
    },
    "componentsProps": {
      "type": { "name": "shape", "description": "{ closeButton?: object, closeIcon?: object }" },
      "default": "{}",
      "deprecated": true,
      "deprecationInfo": "use the <code>slotProps</code> prop instead. This prop will be removed in a future major release. See <a href=\"https://mui.com/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
    },
    "icon": { "type": { "name": "node" } },
    "iconMapping": {
      "type": {
        "name": "shape",
        "description": "{ error?: node, info?: node, success?: node, warning?: node }"
      }
    },
    "onClose": {
      "type": { "name": "func" },
      "signature": {
        "type": "function(event: React.SyntheticEvent) => void",
        "describedArgs": ["event"]
      }
    },
    "role": { "type": { "name": "string" }, "default": "'alert'" },
    "severity": {
      "type": {
        "name": "union",
        "description": "'error'<br>&#124;&nbsp;'info'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
      },
      "default": "'success'"
    },
    "slotProps": {
      "type": {
        "name": "shape",
        "description": "{ action?: func<br>&#124;&nbsp;object, closeButton?: func<br>&#124;&nbsp;object, closeIcon?: func<br>&#124;&nbsp;object, icon?: func<br>&#124;&nbsp;object, message?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
      },
      "default": "{}"
    },
    "slots": {
      "type": {
        "name": "shape",
        "description": "{ action?: elementType, closeButton?: elementType, closeIcon?: elementType, icon?: elementType, message?: elementType, root?: elementType }"
      },
      "default": "{}"
    },
    "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": "'filled'<br>&#124;&nbsp;'outlined'<br>&#124;&nbsp;'standard'<br>&#124;&nbsp;string"
      },
      "default": "'standard'"
    }
  },
  "name": "Alert",
  "imports": ["import Alert from '@mui/material/Alert';", "import { Alert } from '@mui/material';"],
  "slots": [
    {
      "name": "root",
      "description": "The component that renders the root slot.",
      "default": "Paper",
      "class": "MuiAlert-root"
    },
    {
      "name": "icon",
      "description": "The component that renders the icon slot.",
      "default": "div",
      "class": "MuiAlert-icon"
    },
    {
      "name": "message",
      "description": "The component that renders the message slot.",
      "default": "div",
      "class": "MuiAlert-message"
    },
    {
      "name": "action",
      "description": "The component that renders the action slot.",
      "default": "div",
      "class": "MuiAlert-action"
    },
    {
      "name": "closeButton",
      "description": "The component that renders the close button.",
      "default": "IconButton",
      "class": null
    },
    {
      "name": "closeIcon",
      "description": "The component that renders the close icon.",
      "default": "svg",
      "class": null
    }
  ],
  "classes": [
    {
      "key": "colorError",
      "className": "MuiAlert-colorError",
      "description": "Styles applied to the root element if `color=\"error\"`.",
      "isGlobal": false
    },
    {
      "key": "colorInfo",
      "className": "MuiAlert-colorInfo",
      "description": "Styles applied to the root element if `color=\"info\"`.",
      "isGlobal": false
    },
    {
      "key": "colorSuccess",
      "className": "MuiAlert-colorSuccess",
      "description": "Styles applied to the root element if `color=\"success\"`.",
      "isGlobal": false
    },
    {
      "key": "colorWarning",
      "className": "MuiAlert-colorWarning",
      "description": "Styles applied to the root element if `color=\"warning\"`.",
      "isGlobal": false
    },
    {
      "key": "filled",
      "className": "MuiAlert-filled",
      "description": "Styles applied to the root element if `variant=\"filled\"`.",
      "isGlobal": false
    },
    {
      "key": "filledError",
      "className": "MuiAlert-filledError",
      "description": "Styles applied to the root element if `variant=\"filled\"` and `color=\"error\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "filledInfo",
      "className": "MuiAlert-filledInfo",
      "description": "Styles applied to the root element if `variant=\"filled\"` and `color=\"info\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "filledSuccess",
      "className": "MuiAlert-filledSuccess",
      "description": "Styles applied to the root element if `variant=\"filled\"` and `color=\"success\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "filledWarning",
      "className": "MuiAlert-filledWarning",
      "description": "Styles applied to the root element if `variant=\"filled\"` and `color=\"warning\"`",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "outlined",
      "className": "MuiAlert-outlined",
      "description": "Styles applied to the root element if `variant=\"outlined\"`.",
      "isGlobal": false
    },
    {
      "key": "outlinedError",
      "className": "MuiAlert-outlinedError",
      "description": "Styles applied to the root element if `variant=\"outlined\"` and `color=\"error\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "outlinedInfo",
      "className": "MuiAlert-outlinedInfo",
      "description": "Styles applied to the root element if `variant=\"outlined\"` and `color=\"info\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "outlinedSuccess",
      "className": "MuiAlert-outlinedSuccess",
      "description": "Styles applied to the root element if `variant=\"outlined\"` and `color=\"success\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "outlinedWarning",
      "className": "MuiAlert-outlinedWarning",
      "description": "Styles applied to the root element if `variant=\"outlined\"` and `color=\"warning\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "standard",
      "className": "MuiAlert-standard",
      "description": "Styles applied to the root element if `variant=\"standard\"`.",
      "isGlobal": false
    },
    {
      "key": "standardError",
      "className": "MuiAlert-standardError",
      "description": "Styles applied to the root element if `variant=\"standard\"` and `color=\"error\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "standardInfo",
      "className": "MuiAlert-standardInfo",
      "description": "Styles applied to the root element if `variant=\"standard\"` and `color=\"info\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "standardSuccess",
      "className": "MuiAlert-standardSuccess",
      "description": "Styles applied to the root element if `variant=\"standard\"` and `color=\"success\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "standardWarning",
      "className": "MuiAlert-standardWarning",
      "description": "Styles applied to the root element if `variant=\"standard\"` and `color=\"warning\"`.",
      "isGlobal": false,
      "isDeprecated": true
    }
  ],
  "spread": true,
  "themeDefaultProps": true,
  "muiName": "MuiAlert",
  "forwardsRefTo": "HTMLDivElement",
  "filename": "/packages/mui-material/src/Alert/Alert.js",
  "inheritance": { "component": "Paper", "pathname": "/material-ui/api/paper/" },
  "demos": "<ul><li><a href=\"/material-ui/react-alert/\">Alert</a></li></ul>",
  "cssComponent": false
}