Some checks failed
No response / noResponse (push) Has been cancelled
CI / Continuous releases (push) Has been cancelled
CI / test-dev (macos-latest) (push) Has been cancelled
CI / test-dev (ubuntu-latest) (push) Has been cancelled
CI / test-dev (windows-latest) (push) Has been cancelled
Maintenance / main (push) Has been cancelled
Scorecards supply-chain security / Scorecards analysis (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled
158 lines
11 KiB
JSON
158 lines
11 KiB
JSON
{
|
|
"componentDescription": "",
|
|
"propDescriptions": {
|
|
"action": {
|
|
"description": "The action to display. It renders after the message, at the end of the alert."
|
|
},
|
|
"children": { "description": "The content of the component." },
|
|
"classes": { "description": "Override or extend the styles applied to the component." },
|
|
"closeText": {
|
|
"description": "Override the default label for the <em>close popup</em> icon button.<br>For localization purposes, you can use the provided <a href=\"https://mui.com/material-ui/guides/localization/\">translations</a>."
|
|
},
|
|
"color": {
|
|
"description": "The color of the component. Unless provided, the value is taken from the <code>severity</code> prop. It supports both default and custom theme colors, which can be added as shown in the <a href=\"https://mui.com/material-ui/customization/palette/#custom-colors\">palette customization guide</a>."
|
|
},
|
|
"components": { "description": "The components used for each slot inside." },
|
|
"componentsProps": {
|
|
"description": "The extra props for the slot components. You can override the existing props or add new ones."
|
|
},
|
|
"icon": {
|
|
"description": "Override the icon displayed before the children. Unless provided, the icon is mapped to the value of the <code>severity</code> prop. Set to <code>false</code> to remove the <code>icon</code>."
|
|
},
|
|
"iconMapping": {
|
|
"description": "The component maps the <code>severity</code> prop to a range of different icons, for instance success to <code><SuccessOutlined></code>. If you wish to change this mapping, you can provide your own. Alternatively, you can use the <code>icon</code> prop to override the icon displayed."
|
|
},
|
|
"onClose": {
|
|
"description": "Callback fired when the component requests to be closed. When provided and no <code>action</code> prop is set, a close icon button is displayed that triggers the callback when clicked.",
|
|
"typeDescriptions": {
|
|
"event": { "name": "event", "description": "The event source of the callback." }
|
|
}
|
|
},
|
|
"role": { "description": "The ARIA role attribute of the element." },
|
|
"severity": {
|
|
"description": "The severity of the alert. This defines the color and icon used."
|
|
},
|
|
"slotProps": { "description": "The props used for each slot inside." },
|
|
"slots": { "description": "The components used for each slot inside." },
|
|
"sx": {
|
|
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
|
|
},
|
|
"variant": { "description": "The variant to use." }
|
|
},
|
|
"classDescriptions": {
|
|
"colorError": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>color=\"error\"</code>"
|
|
},
|
|
"colorInfo": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>color=\"info\"</code>"
|
|
},
|
|
"colorSuccess": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>color=\"success\"</code>"
|
|
},
|
|
"colorWarning": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>color=\"warning\"</code>"
|
|
},
|
|
"filled": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"filled\"</code>"
|
|
},
|
|
"filledError": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"filled\"</code> and <code>color=\"error\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-filled\">.MuiAlert-filled</a> and <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-colorError\">.MuiAlert-colorError</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"filledInfo": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"filled\"</code> and <code>color=\"info\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-filled\">.MuiAlert-filled</a> and <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-colorInfo\">.MuiAlert-colorInfo</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"filledSuccess": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"filled\"</code> and <code>color=\"success\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-filled\">.MuiAlert-filled</a> and <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-colorSuccess\">.MuiAlert-colorSuccess</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"filledWarning": {
|
|
"description": "Styles applied to the root element if <code>variant="filled"</code> and <code>color="warning"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-filled\">.MuiAlert-filled</a> and <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-colorWarning\">.MuiAlert-colorWarning</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"outlined": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"outlined\"</code>"
|
|
},
|
|
"outlinedError": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"outlined\"</code> and <code>color=\"error\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-outlined\">.MuiAlert-outlined</a> and <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-colorError\">.MuiAlert-colorError</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"outlinedInfo": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"outlined\"</code> and <code>color=\"info\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-outlined\">.MuiAlert-outlined</a> and <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-colorInfo\">.MuiAlert-colorInfo</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"outlinedSuccess": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"outlined\"</code> and <code>color=\"success\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-outlined\">.MuiAlert-outlined</a> and <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-colorSuccess\">.MuiAlert-colorSuccess</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"outlinedWarning": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"outlined\"</code> and <code>color=\"warning\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-outlined\">.MuiAlert-outlined</a> and <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-colorWarning\">.MuiAlert-colorWarning</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"standard": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"standard\"</code>"
|
|
},
|
|
"standardError": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"standard\"</code> and <code>color=\"error\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-standard\">.MuiAlert-standard</a> and <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-colorError\">.MuiAlert-colorError</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"standardInfo": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"standard\"</code> and <code>color=\"info\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-standard\">.MuiAlert-standard</a> and <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-colorInfo\">.MuiAlert-colorInfo</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"standardSuccess": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"standard\"</code> and <code>color=\"success\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-standard\">.MuiAlert-standard</a> and <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-colorSuccess\">.MuiAlert-colorSuccess</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"standardWarning": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"standard\"</code> and <code>color=\"warning\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-standard\">.MuiAlert-standard</a> and <a href=\"/material-ui/api/alert/#alert-classes-MuiAlert-colorWarning\">.MuiAlert-colorWarning</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
}
|
|
},
|
|
"slotDescriptions": {
|
|
"action": "The component that renders the action slot.",
|
|
"closeButton": "The component that renders the close button.",
|
|
"closeIcon": "The component that renders the close icon.",
|
|
"icon": "The component that renders the icon slot.",
|
|
"message": "The component that renders the message slot.",
|
|
"root": "The component that renders the root slot."
|
|
}
|
|
}
|