Files
directus/docs/reference/app/components/v-radio.md
Nitwel c2e7c85bbd Update documentation of app (#4222)
* move component docs to documentation

* update app docs tables for components

* update docs

* Add components to docs sidebar

* fix generated tables

* fix tables

* rename transitions

* update tables

* update nested components

* update tables

* update tables

* update tables

* update v-table table

* add basic documentation to each component

* remove all stories of storybook

* add missing documentation

* undate tables

* update tables

* update docs sidebar

* update app docs

* remove unused references

* add general readme

* update docs

* make reference titiles smaller

* add reference tag

* improve docs

* update order of tabs in sidebar

* remove all readmes and stories from interfaces/displays

* Cleanup menu

* Remove storybook

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2021-02-24 17:48:19 -05:00

42 lines
1.9 KiB
Markdown

# Radio
Classic radio buttons. Nothing special.
```html
<v-radio v-model="selected" value="red" />
<v-radio v-model="selected" value="blue" />
<v-radio v-model="selected" value="green" />
```
## Reference
#### Props
| Prop | Description | Default | Type |
| ------------- | ------------------------------------------- | -------------------------- | --------- |
| `value`\* | What value to represent when selected | | `String` |
| `input-value` | Selected value. Used as value for `v-model` | `null` | `String` |
| `label` | Label to render next to the radio | `null` | `String` |
| `disabled` | Disable the radio button | `false` | `Boolean` |
| `icon-on` | Change the icon to display when enabled | `'radio_button_checked'` | `String` |
| `icon-off` | Change the icon to display when disabled | `'radio_button_unchecked'` | `String` |
| `block` | Render the radio in a block like style | `false` | `Boolean` |
#### Events
| Event | Description | Value |
| -------- | ------------------------------------------------------------- | -------- |
| `change` | When the state of the radio button changes. Used in `v-model` | `string` |
#### Slots
| Slot | Description | Data |
| ------- | --------------------------------------------------------------------------------- | ---- |
| `label` | Custom override for label slot. Allows you to render custom markup in label slot. | |
#### CSS Variables
| Variable | Default |
| ----------------- | ---------------- |
| `--v-radio-color` | `var(--primary)` |