mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-14 20:19:34 +01:00
docs(checkbox): update
This commit is contained in:
@@ -11,6 +11,133 @@ links:
|
||||
|
||||
## Usage
|
||||
|
||||
Use the `v-model` directive to control the checked state of the Checkbox.
|
||||
|
||||
::component-code
|
||||
---
|
||||
external:
|
||||
- modelValue
|
||||
ignore:
|
||||
- label
|
||||
props:
|
||||
label: Check me
|
||||
modelValue: true
|
||||
---
|
||||
::
|
||||
|
||||
Use the `default-value` prop to set the initial value of the Checkbox when you do not need to control its state.
|
||||
|
||||
::component-code
|
||||
---
|
||||
ignore:
|
||||
- label
|
||||
props:
|
||||
label: Check me
|
||||
defaultValue: true
|
||||
---
|
||||
::
|
||||
|
||||
Use the `indeterminate` prop to set the Checkbox to an [indeterminate state](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes).
|
||||
|
||||
::component-code
|
||||
---
|
||||
ignore:
|
||||
- label
|
||||
props:
|
||||
label: Check me
|
||||
indeterminate: true
|
||||
---
|
||||
::
|
||||
|
||||
### Label
|
||||
|
||||
Use the `label` prop to set the label of the Checkbox.
|
||||
|
||||
::component-code
|
||||
---
|
||||
props:
|
||||
label: Check me
|
||||
---
|
||||
::
|
||||
|
||||
### Description
|
||||
|
||||
Use the `description` prop to set the description of the Checkbox.
|
||||
|
||||
::component-code
|
||||
---
|
||||
ignore:
|
||||
- label
|
||||
props:
|
||||
label: Check me
|
||||
description: 'This is a checkbox.'
|
||||
---
|
||||
::
|
||||
|
||||
### Icon
|
||||
|
||||
Use the `icon` prop to set the icon of the Checkbox when it is checked. Defaults to `i-heroicons-check-20-solid`.
|
||||
|
||||
::component-code
|
||||
---
|
||||
ignore:
|
||||
- label
|
||||
- defaultValue
|
||||
props:
|
||||
label: Check me
|
||||
icon: 'i-heroicons-heart'
|
||||
defaultValue: true
|
||||
---
|
||||
::
|
||||
|
||||
::tip
|
||||
You can customize this icon globally in your `app.config.ts` under `ui.icons.check` key.
|
||||
::
|
||||
|
||||
### Style
|
||||
|
||||
Use the `color` prop to change the style of the Checkbox.
|
||||
|
||||
::component-code
|
||||
---
|
||||
ignore:
|
||||
- label
|
||||
- defaultValue
|
||||
props:
|
||||
label: Check me
|
||||
color: gray
|
||||
defaultValue: true
|
||||
---
|
||||
::
|
||||
|
||||
### Size
|
||||
|
||||
Use the `size` prop to change the size of the Checkbox.
|
||||
|
||||
::component-code
|
||||
---
|
||||
ignore:
|
||||
- label
|
||||
- defaultValue
|
||||
props:
|
||||
label: Check me
|
||||
size: xl
|
||||
defaultValue: true
|
||||
---
|
||||
::
|
||||
|
||||
### Disabled
|
||||
|
||||
::component-code
|
||||
---
|
||||
ignore:
|
||||
- label
|
||||
props:
|
||||
label: Check me
|
||||
disabled: true
|
||||
---
|
||||
::
|
||||
|
||||
## Examples
|
||||
|
||||
## API
|
||||
|
||||
Reference in New Issue
Block a user