Badge

用于在标题、项目或表格行旁展示简短状态与分类。

预览

五种徽标样式

并排比较默认、primary、soft、outline 和 destructive 标签。

DefaultPrimarySoftOutlineDestructive

安装

首次使用此 Registry?请先完成 基础配置与共享样式安装 。

npx shadcn@latest add @neumorphism-ui/badge

先安装一次共享 base,然后使用 CLI 添加组件及其依赖。

Registry JSON

用法

在 Badge 中放入简短名称,通过 variant 调整强调程度。需要执行操作时使用按钮或链接。

import { Badge } from "@/components/ui/badge";

export default function Example() {
  return <Badge variant="primary">Ready</Badge>;
}

API 参考

一个轻量的 span 组件,提供五种变体。它只提供视觉强调,不附加交互行为或隐式 ARIA role。

组件属性类型默认值说明
Badgevariant"default" | "primary" | "soft" | "outline" | "destructive""default"选择状态的强调程度和颜色。
Badgechildren必填React.ReactNode—简短的状态或分类文本。
BadgeclassNamestring—扩展尺寸、间距和颜色。

无障碍

  • 01

    Badge 默认渲染为 span,因此必须直接提供能够说明状态的文本。

  • 02

    不要只用颜色区分状态,应使用 Ready、Failed 等明确文案。

  • 03

    如需点击操作,不要直接给 Badge 绑定事件,而应将其放在 Button 或链接中。