徽章

徽章用作 UI 元素的小数值或状态描述符。


安装

npx nextui-cli@latest add badge
上述命令仅用于单独安装。如果已全局安装 @nextui-org/react,则可以跳过此步骤。

导入

用法

尺寸

颜色

变体

位置

形状

为了更好的定位,你可以使用 shape 属性来定义徽章的形状。

徽章可见性

你可以通过使用 isInvisible 属性来控制徽章的可见性。

内容示例

禁用边框

默认情况下,徽章有一个边框,你可以通过使用 showOutline={false} 属性来禁用它。

无障碍

不建议依赖徽章的内容来进行准确的播报。相反,考虑提供一个全面的描述,例如使用 aria-label

API

徽章属性

属性类型描述默认值
children *ReactNode包裹的组件。-
contentstring | number | ReactNode徽章的内容。徽章将相对于其子元素进行渲染。-
variantsolid | flat | faded | shadow徽章的变体样式。solid
colordefault | primary | secondary | success | warning | danger徽章的颜色。default
sizesm | md | lg徽章的大小。md
shapecircle | rectangle徽章的形状。rectangle
placementtop-right | top-left | bottom-right | bottom-left徽章的位置。top-right
showOutlineboolean如果为 true,徽章将有轮廓。true
disableOutlineboolean如果为 true,徽章将没有轮廓。 已弃用 改用 showOutlinefalse
disableAnimationboolean如果为 true,徽章将没有动画。false
isInvisibleboolean如果为 true,徽章将不可见。false
isOneCharboolean如果 true,徽章将具有相同的宽度和高度。false
isDotboolean如果 true,徽章将具有较小的尺寸。false
classNamesRecord<"base"|"badge", string>允许为徽章插槽设置自定义类名。-