{
"componentDescription": "",
"propDescriptions": {
"anchorOrigin": { "description": "The anchor of the badge." },
"badgeContent": { "description": "The content rendered within the badge." },
"badgeInset": {
"description": "The inset of the badge. Support shorthand syntax as described in https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Properties/inset."
},
"children": { "description": "The badge will be added relative to this node." },
"color": {
"description": "The color of the component. It supports those theme colors that make sense for this component."
},
"component": {
"description": "The component used for the root node. Either a string to use a HTML element or a component."
},
"invisible": { "description": "If true, the badge is invisible." },
"max": { "description": "Max count to show." },
"showZero": {
"description": "Controls whether the badge is hidden when badgeContent is zero."
},
"size": { "description": "The size of the component." },
"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 global variant to use."
}
},
"classDescriptions": {
"anchorOriginBottomLeft": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'bottom', 'left' }}"
},
"anchorOriginBottomRight": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'bottom', 'right' }}"
},
"anchorOriginTopLeft": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'top', 'left' }}"
},
"anchorOriginTopRight": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "anchorOrigin={{ 'top', 'right' }}"
},
"colorContext": {
"description": "Class name applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the root element",
"conditions": "color inversion is triggered"
},
"colorDanger": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "color=\"danger\""
},
"colorNeutral": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "color=\"neutral\""
},
"colorPrimary": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "color=\"primary\""
},
"colorSuccess": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "color=\"success\""
},
"colorWarning": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "color=\"warning\""
},
"invisible": {
"description": "State class applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "invisible={true}"
},
"locationInside": {
"description": "State class applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "location=\"inside\""
},
"locationOutside": {
"description": "State class applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "location=\"outside\""
},
"sizeLg": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "size=\"lg\""
},
"sizeMd": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "size=\"md\""
},
"sizeSm": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "size=\"sm\""
},
"variantOutlined": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "variant=\"outlined\""
},
"variantPlain": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the root element",
"conditions": "variant=\"plain\""
},
"variantSoft": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "variant=\"soft\""
},
"variantSolid": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge span element",
"conditions": "variant=\"solid\""
}
},
"slotDescriptions": {
"badge": "The component that renders the badge.",
"root": "The component that renders the root."
}
}