Skip to content

徽章 ​

VitePress 提供内置的 Badge 组件来显示状态。

用法 ​

你可以在标题或任何其他内容中使用 Badge 组件。

标题 ​

md
### Title <Badge type="info" text="default" />
### Title <Badge type="tip" text="^1.9.0" />
### Title <Badge type="warning" text="beta" />
### Title <Badge type="danger" text="caution" />

Title default ​

Title ^1.9.0 ​

Title beta ​

Title caution ​

自定义子项 ​

md
<Badge type="info" text="custom element" />
custom element

自定义类型颜色 ​

你可以通过覆盖 css 变量来自定义徽章的样式。以下是默认值:

css
:root {
  --vp-badge-info-border: transparent;
  --vp-badge-info-text: var(--vp-c-text-2);
  --vp-badge-info-bg: var(--vp-c-default-soft);

  --vp-badge-tip-border: transparent;
  --vp-badge-tip-text: var(--vp-c-brand-1);
  --vp-badge-tip-bg: var(--vp-c-brand-soft);

  --vp-badge-warning-border: transparent;
  --vp-badge-warning-text: var(--vp-c-warning-1);
  --vp-badge-warning-bg: var(--vp-c-warning-soft);

  --vp-badge-danger-border: transparent;
  --vp-badge-danger-text: var(--vp-c-danger-1);
  --vp-badge-danger-bg: var(--vp-c-danger-soft);
}

<Badge> ​

Badge 组件接受以下 props:

ts
interface Props {
  // 当 `<slot>` 不存在时,显示此文本
  text?: string

  // 徽章的类型
  type?: 'info' | 'tip' | 'warning' | 'danger'
}

vitepress开发指南