mirror of https://github.com/vuejs/vitepress
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
86 lines
2.3 KiB
86 lines
2.3 KiB
---
|
|
description: Use the Badge component to add status labels to headers in VitePress documentation.
|
|
---
|
|
|
|
# Badge
|
|
|
|
The badge lets you add status to your headers. For example, it could be useful to specify the section's type, or supported version.
|
|
|
|
## Usage
|
|
|
|
You may use the `Badge` component which is globally available.
|
|
|
|
```html
|
|
### 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="deprecated" />
|
|
```
|
|
|
|
Code above renders like:
|
|
|
|
### 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="deprecated" />
|
|
|
|
## Custom Children
|
|
|
|
`<Badge>` accept `children`, which will be displayed in the badge.
|
|
|
|
```html
|
|
### Title <Badge type="info">custom element</Badge>
|
|
```
|
|
|
|
### Title <Badge type="info">custom element</Badge>
|
|
|
|
## Customize Type Color
|
|
|
|
You can customize the style of badges by overriding css variables. The following are the default values:
|
|
|
|
```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>` component accepts following props:
|
|
|
|
```ts
|
|
interface Props {
|
|
// When `<slot>` is passed, this value gets ignored.
|
|
text?: string
|
|
|
|
// Defaults to `tip`. Matches markdown containers/alerts colors.
|
|
type?: 'info' | 'note' | 'tip' | 'important' | 'caution' | 'warning' | 'danger'
|
|
}
|
|
```
|