Files
flowbite-vue/docs/components/toggle.md
Ilya Artamonov d316cf3a12 Components renaming (#225)
* refactor: eslint config adjusted for better diff's

* refactor: stricter linting
 + dependencies updated

* refactoring: paragraph component
 - component
 - docs

* refactoring: heading component
 - component
 - docs

* Update docs/components/heading.md

Co-authored-by: Ilya Artamonov <ilya.sosidka@gmail.com>

* refactoring: link component
 - component
 - docs

* refactoring: image component
 - component
 - docs

* refactoring: alert component
 - component
 - docs

* refactoring: avatar component
 - component
 - docs

* refactoring: removed unnecessary code
    - component names come from the file name

* refactoring: breadcrumb component
 - component
 - docs

* refactoring: accordion component
 - component
 - docs

* refactoring: buttom component
 - component
 - docs

* refactoring: badge component
 - component
 - docs

* refactoring: card component
 - component
 - docs

* refactoring: order of components in docs updated

* refactoring: unnecessary semicolons removed

* refactoring: button group component
 - component
 - docs

* refactoring: carousel component
 - component
 - docs

* refactoring: dropdown component
 - component
 - docs

* refactoring: footer component
 - component
 - docs

* refactoring:list-group component
 - component
 - docs

* refactoring: modal component
 - component
 - docs

* refactoring: navbar component
 - component
 - docs

* refactoring: pagination component
 - component
 - docs

* refactoring: progress component
 - component
 - docs

* refactoring: rating component
 - component
 - docs

* refactoring: spinner component
 - component
 - docs

* refactoring: table component
 - component
 - docs

* refactoring: tabs component
 - component
 - docs

* feat: Updated pagination examples

* lint: Lister fixes

* feat: Sidebar component and some fixes

* feat: Input component

* feat: Some fixes

* feat: Some fixes

* chore: update deps

* refactor: removed old Modal component

* refactor: radio component and some fixes

* fix: fixed path error

* refactor: Range component

* refactoring: timeline component
 - component
 - docs

* refactor: Select component

* refactoring: toast component
 - component
 - docs

* refactoring: tooltip component
 - component
 - docs

* refactoring: sidebar component
 - component
 - docs

* refactoring: input component
 - component
 - docs

* refactoring: fileInput component
 - component
 - docs

* refactoring: select component
 - component
 - docs

* refactoring: textarea component
 - component
 - docs

* refactoring: checkbox component
 - component
 - docs

* refactoring: radio component
 - component
 - docs

* refactoring: toggle component
 - component
 - docs

* refactoring: range component
 - component
 - docs

* local configs linted

* documentation quick start updated

* flowbite-themable refactored to fit new linters and style guide

* random linter fixes

* refactoring: toast-provider component
 - component
 - docs

* final linter fixes

* lint: Linter fixes

* fix: Fixed types

* fix: Fixed card component

* docs: Updated card examples

* fix: Fixed tabs

* refactor: Heading component refactoring

* Fwb rename - few fixes after component review (#237)

* fix: button documentation

* fix: model type in range examples

* chore: Toast marked as WIP

---------

Co-authored-by: Sqrcz <naorniakowski@slashlab.pl>
Co-authored-by: Sqrcz <naorniakowski@gmail.com>
2023-10-23 18:23:14 +03:00

97 lines
2.3 KiB
Markdown

<script setup>
import FwbToggleExample from './toggle/examples/FwbToggleExample.vue'
import FwbToggleExampleChecked from './toggle/examples/FwbToggleExampleChecked.vue'
import FwbToggleExampleColors from './toggle/examples/FwbToggleExampleColors.vue'
import FwbToggleExampleDisabled from './toggle/examples/FwbToggleExampleDisabled.vue'
import FwbToggleExampleSize from './toggle/examples/FwbToggleExampleSize.vue'
</script>
# Vue Toggle - Flowbite
#### Use the toggle component to switch between a binary state of true or false using a single click available in multiple sizes, variants, and colors
---
:::tip
Original reference: [https://flowbite.com/docs/forms/toggle/](https://flowbite.com/docs/forms/toggle/)
:::
The toggle component can be used to receive a simple “yes” or “no” type of answer from the user by choosing a single option from two options available in multiple sizes, styles, and colors coded with the utility classes from Tailwind CSS and with dark mode support.
## Default toggle
<fwb-toggle-example />
```vue
<template>
<fwb-toggle v-model="toggle" label="Toggle me" />
</template>
<script setup>
import { ref } from 'vue'
import { FwbToggle } from 'flowbite-vue'
const toggle = ref(false)
</script>
```
## Checked toggle
<fwb-toggle-example-checked />
```vue
<template>
<fwb-toggle v-model="toggle" label="Toggle me" />
</template>
<script setup>
import { ref } from 'vue'
import { FwbToggle } from 'flowbite-vue'
const toggle = ref(true)
</script>
```
## Disabled toggle
<fwb-toggle-example-disabled />
```vue
<template>
<fwb-toggle v-model="toggle" disabled label="Can't Toggle me" />
</template>
<script setup>
import { ref } from 'vue'
import { FwbToggle } from 'flowbite'
const toggle = ref(false)
</script>
```
## Colors
<fwb-toggle-example-colors />
```vue
<template>
<fwb-toggle label="Red" color="red" />
<fwb-toggle label="Green" color="green" />
<fwb-toggle label="Purple" color="purple" />
<fwb-toggle label="Yellow" color="yellow" />
<fwb-toggle label="Teal" color="teal" />
<fwb-toggle label="Orange" color="orange" />
</template>
```
## Size
<fwb-toggle-example-size />
```vue
<template>
<fwb-toggle label="Small" size="sm" />
<fwb-toggle label="Medium" size="md" />
<fwb-toggle label="Large" size="lg" />
</template>
<script setup>
import { FwbToggle } from 'flowbite-vue'
</script>
```