Значки

С помощью значков удобно добавлять статус к заголовкам. Например, может быть полезно указать тип раздела или поддерживаемую версию.

Использование

Вы можете использовать компонент Badge, который доступен глобально.

### Заголовок <Badge type="info" text="по умолчанию" />
### Заголовок <Badge type="tip" text="^1.9.0" />
### Заголовок <Badge type="warning" text="beta" />
### Заголовок <Badge type="danger" text="устарело" />

Приведённый выше код даёт такой результат:

Заголовок по умолчанию

Заголовок ^1.9.0

Заголовок beta

Заголовок устарело

Дочерние элементы

<Badge> принимает параметр children, который будет отображаться внутри значка.

### Заголовок <Badge type="info">вложенный элемент</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-note-border: transparent;
  --vp-badge-note-text: var(--vp-c-note-1);
  --vp-badge-note-bg: var(--vp-c-note-soft);

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

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

  --vp-badge-caution-border: transparent;
  --vp-badge-caution-text: var(--vp-c-caution-1);
  --vp-badge-caution-bg: var(--vp-c-caution-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 {
  // Когда передается `<slot>`, это значение игнорируется.
  text?: string

  // По умолчанию `tip`. Соответствует цветам контейнеров/оповещений Markdown.
  type?: 'info' | 'note' | 'tip' | 'important' | 'caution' | 'warning' | 'danger'
}