Files
ui/docs/content/3.components/badge.md
2024-07-10 18:43:59 +02:00

84 lines
1.0 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/benjamincanac/ui3/tree/dev/src/runtime/components/Badge.vue
---
## Usage
Use the default slot to set the label of the Badge.
::component-code
---
slots:
default: Badge
---
::
You can achieve the same result by using the `label` prop.
::component-code
---
props:
label: Badge
---
::
### Style
Use the `color` and `variant` props to change the style of the Badge.
::component-code
---
props:
color: gray
variant: solid
slots:
default: Badge
---
::
### Size
Use the `size` prop to change the size of the Badge.
::component-code
---
props:
size: md
slots:
default: Badge
---
::
## Examples
### `class` prop
Use the `class` prop to override the base styles of the Badge.
::component-code
---
props:
class: 'font-bold rounded-full'
slots:
default: Badge
---
::
## API
### Props
:component-props
### Slots
:component-slots
## Theme
:component-theme