mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-17 13:38:07 +01:00
140 lines
1.7 KiB
Markdown
140 lines
1.7 KiB
Markdown
---
|
|
description: Display a short text to represent a status or a category.
|
|
links:
|
|
- label: GitHub
|
|
icon: i-simple-icons-github
|
|
to: https://github.com/nuxt/ui/blob/dev/src/runtime/components/elements/Badge.vue
|
|
---
|
|
|
|
## Usage
|
|
|
|
Use the default slot to set the text of the Badge.
|
|
|
|
::component-card
|
|
---
|
|
code: Badge
|
|
---
|
|
|
|
Badge
|
|
::
|
|
|
|
You can also use the `label` prop:
|
|
|
|
::component-card
|
|
---
|
|
props:
|
|
label: Badge
|
|
---
|
|
::
|
|
|
|
### Style
|
|
|
|
Use the `color` and `variant` props to change the visual style of the Badge.
|
|
|
|
- `variant` can be `solid` (default), `outline`, `soft` or `subtle`.
|
|
|
|
::component-card
|
|
---
|
|
props:
|
|
color: 'primary'
|
|
variant: 'solid'
|
|
---
|
|
|
|
Badge
|
|
::
|
|
|
|
Besides all the colors from the `ui.colors` object, you can also use the `white` and `black` colors with their pre-defined variants.
|
|
|
|
#### White
|
|
|
|
::component-card
|
|
---
|
|
props:
|
|
color: 'white'
|
|
variant: 'solid'
|
|
ui:
|
|
variant:
|
|
solid: 1
|
|
excludedProps:
|
|
- color
|
|
---
|
|
|
|
Badge
|
|
::
|
|
|
|
#### Gray
|
|
|
|
::component-card
|
|
---
|
|
props:
|
|
color: 'gray'
|
|
variant: 'solid'
|
|
ui:
|
|
variant:
|
|
solid: 1
|
|
excludedProps:
|
|
- color
|
|
---
|
|
|
|
Badge
|
|
::
|
|
|
|
#### Black
|
|
|
|
::component-card
|
|
---
|
|
props:
|
|
color: 'black'
|
|
variant: 'solid'
|
|
ui:
|
|
variant:
|
|
solid: 1
|
|
link: 1
|
|
excludedProps:
|
|
- color
|
|
---
|
|
|
|
Badge
|
|
::
|
|
|
|
### Size
|
|
|
|
Use the `size` prop to change the size of the Badge.
|
|
|
|
::component-card
|
|
---
|
|
props:
|
|
size: 'sm'
|
|
---
|
|
|
|
Badge
|
|
::
|
|
|
|
### Rounded
|
|
|
|
To customize the border radius of the Badge, you can use the `ui` prop.
|
|
|
|
::component-card
|
|
---
|
|
props:
|
|
ui:
|
|
rounded: 'rounded-full'
|
|
excludedProps:
|
|
- ui
|
|
---
|
|
|
|
Badge
|
|
::
|
|
|
|
::callout{icon="i-heroicons-light-bulb"}
|
|
You can customize the whole [preset](#preset) by using the `ui` prop.
|
|
::
|
|
|
|
## Props
|
|
|
|
:component-props
|
|
|
|
## Preset
|
|
|
|
:component-preset
|