{
"componentDescription": "",
"propDescriptions": {
"anchorOrigin": { "description": "The anchor of the badge." },
"badgeContent": { "description": "The content rendered within the badge." },
"children": { "description": "The badge will be added relative to this node." },
"classes": { "description": "Override or extend the styles applied to the component." },
"color": {
"description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide."
},
"component": {
"description": "The component used for the root node. Either a string to use a HTML element or a component."
},
"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."
},
"invisible": { "description": "If true, the badge is invisible." },
"max": { "description": "Max count to show." },
"overlap": { "description": "Wrapped shape the badge should overlap." },
"showZero": {
"description": "Controls whether the badge is hidden when badgeContent is zero."
},
"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": {
"anchorOriginBottomLeft": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'bottom', 'left' }}"
},
"anchorOriginBottomLeftCircular": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'bottom', 'left' }} overlap=\"circular\""
},
"anchorOriginBottomLeftRectangular": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'bottom', 'left' }} overlap=\"rectangular\""
},
"anchorOriginBottomRight": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'bottom', 'right' }}"
},
"anchorOriginBottomRightCircular": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'bottom', 'right' }} overlap=\"circular\""
},
"anchorOriginBottomRightRectangular": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'bottom', 'right' }} overlap=\"rectangular\""
},
"anchorOriginTopLeft": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'top', 'left' }}"
},
"anchorOriginTopLeftCircular": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'top', 'left' }} overlap=\"circular\""
},
"anchorOriginTopLeftRectangular": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'top', 'left' }} overlap=\"rectangular\""
},
"anchorOriginTopRight": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'top', 'right' }}"
},
"anchorOriginTopRightCircular": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'top', 'right' }} overlap=\"circular\""
},
"anchorOriginTopRightRectangular": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'top', 'right' }} overlap=\"rectangular\""
},
"colorError": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "color=\"error\""
},
"colorInfo": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "color=\"info\""
},
"colorPrimary": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "color=\"primary\""
},
"colorSecondary": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "color=\"secondary\""
},
"colorSuccess": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "color=\"success\""
},
"colorWarning": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "color=\"warning\""
},
"dot": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "variant=\"dot\""
},
"invisible": {
"description": "State class applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "invisible={true}"
},
"overlapCircular": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "overlap=\"circular\""
},
"overlapRectangular": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "overlap=\"rectangular\""
},
"standard": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "variant=\"standard\""
}
},
"slotDescriptions": {
"badge": "The component that renders the badge.",
"root": "The component that renders the root."
}
}