mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-15 04:29:37 +01:00
36 lines
623 B
Markdown
36 lines
623 B
Markdown
---
|
|
github: true
|
|
description: Display a toggle field.
|
|
headlessui:
|
|
label: 'Switch'
|
|
to: 'https://headlessui.com/vue/switch'
|
|
---
|
|
|
|
## Usage
|
|
|
|
::component-card
|
|
::
|
|
|
|
### Icon
|
|
|
|
Use any icon from [Iconify](https://icones.js.org) by setting the `on-icon` and `off-icon` props by using this pattern: `i-{collection_name}-{icon_name}` or change it globally in `ui.toggle.default.onIcon` and `ui.toggle.default.offIcon`.
|
|
|
|
::component-card
|
|
---
|
|
props:
|
|
onIcon: 'i-heroicons-check-20-solid'
|
|
offIcon: 'i-heroicons-x-mark-20-solid'
|
|
excludedProps:
|
|
- onIcon
|
|
- offIcon
|
|
---
|
|
::
|
|
|
|
## Props
|
|
|
|
:component-props
|
|
|
|
## Preset
|
|
|
|
:component-preset
|