docs: update

This commit is contained in:
Benjamin Canac
2024-06-26 19:09:05 +02:00
parent c63b3cec6a
commit 0b3ce24eb6
64 changed files with 798 additions and 5258 deletions

View File

@@ -3,148 +3,13 @@ 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
to: https://github.com/nuxt/ui/blob/dev/src/runtime/components/Badge.vue
---
## Usage
Use the default slot to set the text of the Badge.
## Examples
::component-card
---
code: Badge
---
:component-api
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'
code: Badge
---
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'
options:
- name: variant
restriction: expected
values:
- solid
excludedProps:
- color
code: Badge
---
Badge
::
#### Gray
::component-card
---
props:
color: 'gray'
variant: 'solid'
options:
- name: variant
restriction: expected
values:
- solid
excludedProps:
- color
code: Badge
---
Badge
::
#### Black
::component-card
---
props:
color: 'black'
variant: 'solid'
options:
- name: variant
restriction: only
values:
- solid
excludedProps:
- color
code: Badge
---
Badge
::
### Size
Use the `size` prop to change the size of the Badge.
::component-card
---
props:
size: 'sm'
code: Badge
---
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
code: Badge
---
Badge
::
::callout{icon="i-heroicons-light-bulb"}
You can customize the whole [preset](#preset) by using the `ui` prop.
::
## Props
:component-props
## Config
:component-preset
:component-theme