バッジ

バッジを使用するとヘッダーにステータスを追加できます。たとえば、セクションのタイプやサポートされているバージョンを指定するのに役立ちます。

使い方

グローバルに利用可能なBadgeコンポーネントを使用できます。

### 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" />

上記のコードは以下のようにレンダリングされます。

タイトル デフォルト

タイトル ^1.9.0

タイトル ベータ

タイトル 注意

カスタムチャイルド

<Badge> は、バッジに表示されるchildrenを受け入れます。

### Title <Badge type="info">custom element</Badge>

タイトル カスタムエレメント

タイプのカラーをカスタマイズする

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>コンポーネントは次のプロパティを受け入れます。

interface Props {
  // When `<slot>` is passed, this value gets ignored.
  text?: string

  // Defaults to `tip`.
  type?: 'info' | 'tip' | 'warning' | 'danger'
}