BadgeAPI
React 徽章组件的 API 参考文档。了解此导出模块的属性、CSS 和其他 API。
演示
导入
import Badge from '@mui/joy/Badge';
// or
import { Badge } from '@mui/joy';阅读本指南，了解有关最小化捆绑包大小的差异。
也提供原生组件的属性。
| 名称 | 类型 | 默认 | 描述 |
|---|---|---|---|
| anchorOrigin | { horizontal: 'left' | 'right', vertical: 'bottom' | 'top' } | { vertical: 'top', horizontal: 'right', } | 徽章的锚点。 |
| badgeContent | node | '' | 徽章内渲染的内容。 |
| badgeInset | number | string | 0 | 徽章的内边距。支持 https://mdn.org.cn/en-US/docs/Web/CSS/inset 中描述的简写语法。 |
| children | node | - | 徽章将相对于此节点添加。 |
| color | 'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string | 'primary' | 组件的颜色。它支持对该组件有意义的那些主题颜色。 要了解如何添加自己的颜色，请查看主题组件 - 扩展颜色。 |
| component | elementType | - | 用于根节点的组件。可以是用于 HTML 元素的字符串或组件。 |
| invisible | bool | false | 如果为 |
| max | number | 99 | 要显示的最大计数。 |
| showZero | bool | false | 控制当 |
| size | 'sm' | 'md' | 'lg' | string | 'md' | 组件的尺寸。 要了解如何向组件添加自定义尺寸，请查看主题组件 - 扩展尺寸。 |
| slotProps | { badge?: func | object, root?: func | object } | {} | 用于每个内部插槽的属性。 |
| slots | { badge?: elementType, root?: elementType } | {} | 用于每个内部插槽的组件。 有关更多详细信息，请参阅下面的插槽 API。 |
| sx | Array<func | object | bool> | func | object | - | 允许定义系统覆盖以及其他 CSS 样式的系统属性。 有关更多详细信息，请参阅 `sx` 页面。 |
| variant | 'outlined' | 'plain' | 'soft' | 'solid' | string | 'solid' | 要使用的全局变体。 要了解如何添加自己的变体，请查看主题组件 - 扩展变体。 |
ref 被转发到根元素。主题默认属性
您可以使用 JoyBadge 通过主题更改此组件的默认属性。
要了解如何自定义插槽，请查看覆盖组件结构指南。
| 插槽名称 | 类名 | 默认组件 | 描述 |
|---|---|---|---|
| root | .MuiBadge-root | 'span' | 渲染根的组件。 |
| badge | .MuiBadge-badge | 'span' | 渲染徽章的组件。 |
这些类名对于使用 CSS 进行样式设置很有用。当触发特定状态时，它们会应用于组件的插槽。
| 类名 | 规则名称 | 描述 |
|---|---|---|
| .MuiBadge-anchorOriginBottomLeft | anchorOriginBottomLeft | 如果 anchorOrigin={{ 'bottom', 'left' }}，则应用于徽章 span 元素的类名。 |
| .MuiBadge-anchorOriginBottomRight | anchorOriginBottomRight | 如果 anchorOrigin={{ 'bottom', 'right' }}，则应用于徽章 span 元素的类名。 |
| .MuiBadge-anchorOriginTopLeft | anchorOriginTopLeft | 如果 anchorOrigin={{ 'top', 'left' }}，则应用于徽章 span 元素的类名。 |
| .MuiBadge-anchorOriginTopRight | anchorOriginTopRight | 如果 anchorOrigin={{ 'top', 'right' }}，则应用于徽章 span 元素的类名。 |
| .MuiBadge-colorContext | colorContext | 当颜色反转被触发时应用于根元素的类名。 |
| .MuiBadge-colorDanger | colorDanger | 如果 color="danger"，则应用于徽章 span 元素的类名。 |
| .MuiBadge-colorNeutral | colorNeutral | 如果 color="neutral"，则应用于徽章 span 元素的类名。 |
| .MuiBadge-colorPrimary | colorPrimary | 如果 color="primary"，则应用于徽章 span 元素的类名。 |
| .MuiBadge-colorSuccess | colorSuccess | 如果 color="success"，则应用于徽章 span 元素的类名。 |
| .MuiBadge-colorWarning | colorWarning | 如果 color="warning"，则应用于徽章 span 元素的类名。 |
| .MuiBadge-invisible | invisible | 如果 invisible={true}，则应用于徽章 span 元素的状态类。 |
| .MuiBadge-locationInside | locationInside | 如果 location="inside"，则应用于徽章 span 元素的状态类。 |
| .MuiBadge-locationOutside | locationOutside | 如果 location="outside"，则应用于徽章 span 元素的状态类。 |
| .MuiBadge-sizeLg | sizeLg | 如果 size="lg"，则应用于徽章 span 元素的类名。 |
| .MuiBadge-sizeMd | sizeMd | 如果 size="md"，则应用于徽章 span 元素的类名。 |
| .MuiBadge-sizeSm | sizeSm | 如果 size="sm"，则应用于徽章 span 元素的类名。 |
| .MuiBadge-variantOutlined | variantOutlined | 如果 variant="outlined"，则应用于徽章 span 元素的类名。 |
| .MuiBadge-variantPlain | variantPlain | 如果 variant="plain"，则应用于根元素的类名。 |
| .MuiBadge-variantSoft | variantSoft | 如果 variant="soft"，则应用于徽章 span 元素的类名。 |
| .MuiBadge-variantSolid | variantSolid | 如果 variant="solid"，则应用于徽章 span 元素的类名。 |
您可以使用以下自定义选项之一覆盖组件的样式
- 使用全局类名。
- 在自定义主题中使用规则名称作为组件的
styleOverrides属性的一部分。
源代码
如果您在此页面中找不到信息，请考虑查看组件的实现以获取更多详细信息。