Usage
Use a v-model to make the Toggle reactive.
<script setup>const selected = ref(false)</script><template> <UToggle v-model="selected" /></template>Style
Use the color prop to change the style of the Toggle.
<UToggle color="primary" />Icon
Use any icon from Iconify 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.
<UToggle on-icon="i-heroicons-check-20-solid" off-icon="i-heroicons-x-mark-20-solid" />Disabled
Use the disabled prop to disable the Toggle.
<UToggle disabled />Props
name
string
nullui
any
undefinedid
string
nullcolor
any
config.default.coloroffIcon
string
config.default.offIcondisabled
boolean
falsemodelValue
boolean
falsePreset
{ "base": "relative inline-flex h-5 w-9 flex-shrink-0 border-2 border-transparent disabled:cursor-not-allowed disabled:opacity-50 focus:outline-none", "rounded": "rounded-full", "ring": "focus-visible:ring-2 focus-visible:ring-{color}-500 dark:focus-visible:ring-{color}-400 focus-visible:ring-offset-2 focus-visible:ring-offset-white dark:focus-visible:ring-offset-gray-900", "active": "bg-{color}-500 dark:bg-{color}-400", "inactive": "bg-gray-200 dark:bg-gray-700", "container": { "base": "pointer-events-none relative inline-block h-4 w-4 rounded-full bg-white dark:bg-gray-900 shadow transform ring-0 transition ease-in-out duration-200", "active": "translate-x-4 rtl:-translate-x-4", "inactive": "translate-x-0 rtl:-translate-x-0" }, "icon": { "base": "absolute inset-0 h-full w-full flex items-center justify-center transition-opacity", "active": "opacity-100 ease-in duration-200", "inactive": "opacity-0 ease-out duration-100", "on": "h-3 w-3 text-{color}-500 dark:text-{color}-400", "off": "h-3 w-3 text-gray-400 dark:text-gray-500" }, "default": { "onIcon": null, "offIcon": null, "color": "primary" }}