docs(radio-group): update

This commit is contained in:
Benjamin Canac
2024-07-31 14:16:23 +02:00
parent b9e3fcb0f1
commit c3ee509c65
9 changed files with 207 additions and 53 deletions

View File

@@ -11,8 +11,6 @@ links:
## Usage
### Items
Use the `items` prop as an array of objects with the following properties:
- `label?: string`{lang="ts-type"}

View File

@@ -8,8 +8,6 @@ links:
## Usage
### Items
Use the `items` prop as an array of objects with the following properties:
- `label?: string`{lang="ts-type"}

View File

@@ -45,7 +45,7 @@ slots:
### Orientation
Use the `orientation` prop to change the orientation of the buttons.
Use the `orientation` prop to change the orientation of the buttons. Defaults to `horizontal`.
::component-code
---

View File

@@ -17,11 +17,8 @@ Use the `v-model` directive to control the checked state of the Checkbox.
---
external:
- modelValue
ignore:
- label
props:
modelValue: true
label: Check me
---
::
@@ -29,11 +26,8 @@ Use the `default-value` prop to set the initial value when you do not need to co
::component-code
---
ignore:
- label
props:
defaultValue: true
label: Check me
---
::
@@ -45,12 +39,9 @@ Use the `indeterminate-icon` prop to customize this icon. Defaults to `i-heroico
::component-code
---
ignore:
- label
props:
indeterminate: true
indeterminateIcon: ''
label: Check me
---
::
@@ -69,6 +60,18 @@ props:
---
::
When using the `required` prop, an asterisk will be added next to the label.
::component-code
---
ignore:
- label
props:
required: true
label: Check me
---
::
### Description
Use the `description` prop to set the description of the Checkbox.
@@ -135,20 +138,6 @@ props:
---
::
### Required
Use the `required` prop to make the Checkbox required. This will add an asterisk to the label.
::component-code
---
ignore:
- label
props:
required: true
label: Check me
---
::
### Disabled
Use the `disabled` prop to disable the Checkbox.

View File

@@ -12,7 +12,185 @@ links:
## Usage
## Examples
Use the `items` prop as an array of objects with the following properties:
- `label?: string`{lang="ts-type"}
- `description?: string`{lang="ts-type"}
- `value?: string`{lang="ts-type"}
- `disabled?: boolean`{lang="ts-type"}
Use the `v-model` directive to control the value of the RadioGroup.
::component-code
---
external:
- modelValue
- items
props:
modelValue: '1'
items:
- label: 'Option 1'
description: 'This is the first option.'
value: '1'
- label: 'Option 2'
description: 'This is the second option.'
value: '2'
- label: 'Option 3'
description: 'This is the third option.'
value: '3'
---
::
Use the `default-value` prop to set the initial value when you do not need to control its state.
::component-code
---
external:
- items
props:
defaultValue: '1'
items:
- label: 'Option 1'
description: 'This is the first option.'
value: '1'
- label: 'Option 2'
description: 'This is the second option.'
value: '2'
- label: 'Option 3'
description: 'This is the third option.'
value: '3'
---
::
### Legend
Use the `legend` prop to set the legend of the RadioGroup.
::component-code
---
ignore:
- defaultValue
external:
- items
props:
defaultValue: '1'
legend: 'Legend'
items:
- label: 'Option 1'
description: 'This is the first option.'
value: '1'
- label: 'Option 2'
description: 'This is the second option.'
value: '2'
- label: 'Option 3'
description: 'This is the third option.'
value: '3'
---
::
### Orientation
Use the `orientation` prop to change the orientation of the RadioGroup. Defaults to `vertical`.
::component-code
---
ignore:
- defaultValue
external:
- items
props:
defaultValue: '1'
orientation: 'horizontal'
items:
- label: 'Option 1'
description: 'This is the first option.'
value: '1'
- label: 'Option 2'
description: 'This is the second option.'
value: '2'
- label: 'Option 3'
description: 'This is the third option.'
value: '3'
---
::
### Color
Use the `color` prop to change the color of the RadioGroup.
::component-code
---
ignore:
- defaultValue
external:
- items
props:
defaultValue: '1'
color: 'gray'
items:
- label: 'Option 1'
description: 'This is the first option.'
value: '1'
- label: 'Option 2'
description: 'This is the second option.'
value: '2'
- label: 'Option 3'
description: 'This is the third option.'
value: '3'
---
::
### Size
Use the `size` prop to change the size of the RadioGroup.
::component-code
---
ignore:
- defaultValue
external:
- items
props:
defaultValue: '1'
size: 'xl'
items:
- label: 'Option 1'
description: 'This is the first option.'
value: '1'
- label: 'Option 2'
description: 'This is the second option.'
value: '2'
- label: 'Option 3'
description: 'This is the third option.'
value: '3'
---
::
### Disabled
Use the `disabled` prop to disable the RadioGroup.
::component-code
---
ignore:
- defaultValue
external:
- items
props:
defaultValue: '1'
disabled: true
items:
- label: 'Option 1'
description: 'This is the first option.'
value: '1'
- label: 'Option 2'
description: 'This is the second option.'
value: '2'
- label: 'Option 3'
description: 'This is the third option.'
value: '3'
---
::
## API

View File

@@ -87,7 +87,7 @@ props:
### Orientation
Use the `orientation` prop to change the orientation of the Slider.
Use the `orientation` prop to change the orientation of the Slider. Defaults to `horizontal`.
::component-code
---

View File

@@ -17,11 +17,8 @@ Use the `v-model` directive to control the checked state of the Switch.
---
external:
- modelValue
ignore:
- label
props:
modelValue: true
label: Check me
---
::
@@ -29,11 +26,8 @@ Use the `default-value` prop to set the initial value when you do not need to co
::component-code
---
ignore:
- label
props:
defaultValue: true
label: Check me
---
::
@@ -48,6 +42,18 @@ props:
---
::
When using the `required` prop, an asterisk will be added next to the label.
::component-code
---
ignore:
- label
props:
required: true
label: Check me
---
::
### Description
Use the `description` prop to set the description of the Switch.
@@ -135,20 +141,6 @@ props:
---
::
### Required
Use the `required` prop to make the Switch required. This will add an asterisk to the label.
::component-code
---
ignore:
- label
props:
required: true
label: Check me
---
::
### Disabled
Use the `disabled` prop to disable the Switch.

View File

@@ -11,8 +11,6 @@ links:
## Usage
### Items
Use the `items` prop as an array of objects with the following properties:
- `label?: string`{lang="ts-type"}
@@ -167,7 +165,7 @@ props:
### Orientation
Use the `orientation` prop to change the orientation of the Tabs.
Use the `orientation` prop to change the orientation of the Tabs. Defaults to `horizontal`.
::component-code
---

View File

@@ -132,6 +132,7 @@ export default defineNuxtConfig({
'UKbd',
'ULink',
'UProgress',
'URadioGroup',
'USlider',
'USwitch',
'UTabs',