You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/pages/api-docs/badge.md
+1-9Lines changed: 1 addition & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ The `MuiBadge` name can be used for providing [default props](/customization/glo
36
36
| <spanclass="prop-name">component</span> | <spanclass="prop-type">elementType</span> | <spanclass="prop-default">'span'</span> | The component used for the root node. Either a string to use a HTML element or a component. |
37
37
| <spanclass="prop-name">invisible</span> | <spanclass="prop-type">bool</span> || If `true`, the badge will be invisible. |
38
38
| <spanclass="prop-name">max</span> | <spanclass="prop-type">number</span> | <spanclass="prop-default">99</span> | Max count to show. |
39
-
| <spanclass="prop-name">overlap</span> | <spanclass="prop-type">'circle'<br>| 'rectangle'<br>| 'circular'<br>| 'rectangular'</span> | <spanclass="prop-default">'rectangle'</span> | Wrapped shape the badge should overlap. |
39
+
| <spanclass="prop-name">overlap</span> | <spanclass="prop-type">'circle'<br>| 'rectangle'</span> | <spanclass="prop-default">'rectangle'</span> | Wrapped shape the badge should overlap. |
40
40
| <spanclass="prop-name">showZero</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | Controls whether the badge is hidden when `badgeContent` is zero. |
41
41
| <spanclass="prop-name">variant</span> | <spanclass="prop-type">'dot'<br>| 'standard'</span> | <spanclass="prop-default">'standard'</span> | The variant to use. |
42
42
@@ -55,21 +55,13 @@ Any other props supplied will be provided to the root element (native element).
55
55
| <spanclass="prop-name">colorError</span> | <spanclass="prop-name">.MuiBadge-colorError</span> | Styles applied to the root element if `color="error"`.
56
56
| <spanclass="prop-name">dot</span> | <spanclass="prop-name">.MuiBadge-dot</span> | Styles applied to the root element if `variant="dot"`.
57
57
| <spanclass="prop-name">anchorOriginTopRightRectangle</span> | <spanclass="prop-name">.MuiBadge-anchorOriginTopRightRectangle</span> | Styles applied to the root element if `anchorOrigin={{ 'top', 'right' }} overlap="rectangle"`.
58
-
| <spanclass="prop-name">anchorOriginTopRightRectangular</span> | <spanclass="prop-name">.MuiBadge-anchorOriginTopRightRectangular</span> | Styles applied to the root element if `anchorOrigin={{ 'top', 'right' }} overlap="rectangular"`.
59
58
| <spanclass="prop-name">anchorOriginBottomRightRectangle</span> | <spanclass="prop-name">.MuiBadge-anchorOriginBottomRightRectangle</span> | Styles applied to the root element if `anchorOrigin={{ 'bottom', 'right' }} overlap="rectangle"`.
60
-
| <spanclass="prop-name">anchorOriginBottomRightRectangular</span> | <spanclass="prop-name">.MuiBadge-anchorOriginBottomRightRectangular</span> | Styles applied to the root element if `anchorOrigin={{ 'bottom', 'right' }} overlap="rectangular"`.
61
59
| <spanclass="prop-name">anchorOriginTopLeftRectangle</span> | <spanclass="prop-name">.MuiBadge-anchorOriginTopLeftRectangle</span> | Styles applied to the root element if `anchorOrigin={{ 'top', 'left' }} overlap="rectangle"`.
62
-
| <spanclass="prop-name">anchorOriginTopLeftRectangular</span> | <spanclass="prop-name">.MuiBadge-anchorOriginTopLeftRectangular</span> | Styles applied to the root element if `anchorOrigin={{ 'top', 'left' }} overlap="rectangular"`.
63
60
| <spanclass="prop-name">anchorOriginBottomLeftRectangle</span> | <spanclass="prop-name">.MuiBadge-anchorOriginBottomLeftRectangle</span> | Styles applied to the root element if `anchorOrigin={{ 'bottom', 'left' }} overlap="rectangle"`.
64
-
| <spanclass="prop-name">anchorOriginBottomLeftRectangular</span> | <spanclass="prop-name">.MuiBadge-anchorOriginBottomLeftRectangular</span> | Styles applied to the root element if `anchorOrigin={{ 'bottom', 'left' }} overlap="rectangular"`.
65
61
| <spanclass="prop-name">anchorOriginTopRightCircle</span> | <spanclass="prop-name">.MuiBadge-anchorOriginTopRightCircle</span> | Styles applied to the root element if `anchorOrigin={{ 'top', 'right' }} overlap="circle"`.
66
-
| <spanclass="prop-name">anchorOriginTopRightCircular</span> | <spanclass="prop-name">.MuiBadge-anchorOriginTopRightCircular</span> | Styles applied to the root element if `anchorOrigin={{ 'top', 'right' }} overlap="circular"`.
67
62
| <spanclass="prop-name">anchorOriginBottomRightCircle</span> | <spanclass="prop-name">.MuiBadge-anchorOriginBottomRightCircle</span> | Styles applied to the root element if `anchorOrigin={{ 'bottom', 'right' }} overlap="circle"`.
68
-
| <spanclass="prop-name">anchorOriginBottomRightCircular</span> | <spanclass="prop-name">.MuiBadge-anchorOriginBottomRightCircular</span> | Styles applied to the root element if `anchorOrigin={{ 'bottom', 'right' }} overlap="circular"`.
69
63
| <spanclass="prop-name">anchorOriginTopLeftCircle</span> | <spanclass="prop-name">.MuiBadge-anchorOriginTopLeftCircle</span> | Styles applied to the root element if `anchorOrigin={{ 'top', 'left' }} overlap="circle"`.
70
-
| <spanclass="prop-name">anchorOriginTopLeftCircular</span> | <spanclass="prop-name">.MuiBadge-anchorOriginTopLeftCircular</span> | Styles applied to the root element if `anchorOrigin={{ 'top', 'left' }} overlap="circular"`.
71
64
| <spanclass="prop-name">anchorOriginBottomLeftCircle</span> | <spanclass="prop-name">.MuiBadge-anchorOriginBottomLeftCircle</span> | Styles applied to the root element if `anchorOrigin={{ 'bottom', 'left' }} overlap="circle"`.
72
-
| <spanclass="prop-name">anchorOriginBottomLeftCircular</span> | <spanclass="prop-name">.MuiBadge-anchorOriginBottomLeftCircular</span> | Styles applied to the root element if `anchorOrigin={{ 'bottom', 'left' }} overlap="circular"`.
73
65
| <spanclass="prop-name">invisible</span> | <spanclass="prop-name">.MuiBadge-invisible</span> | Pseudo-class to the badge `span` element if `invisible={true}`.
74
66
75
67
You can override the style of the component thanks to one of these customization points:
0 commit comments