跳转到内容

BadgeUnstyled API

想要学习更多组件属性和 CSS API,可以查阅 React BadgeUnstyled 组件的 API 文档。

导入

import BadgeUnstyled from '@mui/base/BadgeUnstyled';
// 或
import { BadgeUnstyled } from '@mui/base';
您可以通过 阅读本指南以最小化捆包大小 来了解这种差异。

属性

原生(Native) 组件的属性也是可用的。

名称类型默认值描述
anchorOrigin{ horizontal: 'left'
| 'right', vertical: 'bottom'
| 'top' }
{ vertical: 'top', horizontal: 'right', }
The anchor of the badge.
badgeContentnode
The content rendered within the badge.
childrennode
The badge will be added relative to this node.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
components{ Badge?: elementType, Root?: elementType }{}
The components used for each slot inside the Badge. Either a string to use a HTML element or a component.
componentsProps{ badge?: object, root?: object }{}
The props used for each slot inside the Badge.
invisibleboolfalse
If true, the badge is invisible.
maxnumber99
Max count to show.
showZeroboolfalse
Controls whether the badge is hidden when badgeContent is zero.
variantstring'standard'
The variant to use.

ref 则会被传递到根元素中。

CSS

规则名称全局类名描述
root.MuiBadge-rootStyles applied to the root element.
badge.MuiBadge-badgeClass name applied to the badge `span` element.
dot.MuiBadge-dotClass name applied to the badge `span` element if variant="dot".
standard.MuiBadge-standardClass name applied to the badge `span` element if variant="standard".
anchorOriginTopRight.MuiBadge-anchorOriginTopRightClass name applied to the badge `span` element if anchorOrigin={{ 'top', 'right' }}.
anchorOriginBottomRight.MuiBadge-anchorOriginBottomRightClass name applied to the badge `span` element if anchorOrigin={{ 'bottom', 'right' }}.
anchorOriginTopLeft.MuiBadge-anchorOriginTopLeftClass name applied to the badge `span` element if anchorOrigin={{ 'top', 'left' }}.
anchorOriginBottomLeft.MuiBadge-anchorOriginBottomLeftClass name applied to the badge `span` element if anchorOrigin={{ 'bottom', 'left' }}.
invisible.MuiBadge-invisiblePseudo-class applied to the badge `span` element if invisible={true}.

您可以使用组件自定义选项对组件进行个性化:

演示项目