Switch

The Switch input component — sometimes called "toggle" — offers a choice between one of two values; it's a great option when you want the user to toggle a feature on or off. This component implements the W3C ARIA APG Switch Pattern. Use it with the Field component to access all the functionalities.

Examples

Base

The default value of a checkbox is false when unchecked and true wenn checked. Use the true-value and false-value properties to specify different value that will be used as the modelValue property when the specific radio is checked and unchecked

Show code

HTML

<section>
    <o-field>
        <o-switch label="Default" />
    </o-field>

    <o-field>
        <o-switch v-model="isSwitched">
            {{ isSwitched }}
        </o-switch>
    </o-field>

    <o-field>
        <o-switch
            v-model="isSwitchedCustom"
            true-value="Yes"
            false-value="No">
            {{ isSwitchedCustom }}
        </o-switch>
    </o-field>

    <o-field>
        <o-switch disabled>Disabled</o-switch>
    </o-field>
</section>

JS

import { ref } from "vue";

const isSwitched = ref(false);
const isSwitchedCustom = ref("Yes");

Variants

Different styles can be achieved with the variant prop.

Show code

HTML

<section>
    <o-field>
        <o-switch :model-value="true" label="Default" />
    </o-field>

    <o-field>
        <o-switch :model-value="true" variant="primary" label="Primary" />
    </o-field>

    <o-field>
        <o-switch
            :model-value="true"
            variant="secondary"
            label="Secondary" />
    </o-field>

    <o-field>
        <o-switch :model-value="true" variant="info" label="Info" />
    </o-field>

    <o-field>
        <o-switch :model-value="true" variant="success" label="Success" />
    </o-field>

    <o-field>
        <o-switch :model-value="true" variant="warning" label="Warning" />
    </o-field>

    <o-field>
        <o-switch :model-value="true" variant="danger" label="Danger" />
    </o-field>
</section>

Sizes

The component can be displayed in different sizes using the size prop.

Show code

HTML

<section>
    <o-field>
        <o-switch size="small" label="Small" />
    </o-field>

    <o-field>
        <o-switch label="Default" />
    </o-field>

    <o-field>
        <o-switch size="medium" label="Medium" />
    </o-field>

    <o-field>
        <o-switch size="large" label="Large" />
    </o-field>
</section>

Customise

By default, the component supports a label which is displayed to the right of the toggle unless the position prop is set to "left".

Show code

HTML

<section>
    <o-field grouped>
        <o-switch v-model="isRounded" label="Rounded" />
        <o-switch
            v-model="position"
            true-value="left"
            false-value="right"
            label="Label on left" />
    </o-field>
    <o-field grouped>
        <o-field label="Variant">
            <o-select v-model="variant" expanded placeholder="Variant">
                <option :value="undefined">Default</option>
                <option value="primary">Primary</option>
                <option value="secondary">Secondary</option>
                <option value="success">Success</option>
                <option value="info">Info</option>
                <option value="warning">Warning</option>
                <option value="danger">Danger</option>
            </o-select>
        </o-field>
        <o-field label="Passive Variant">
            <o-select
                v-model="passive"
                expanded
                placeholder="Passive Variant">
                <option :value="undefined">Default</option>
                <option value="primary">Primary</option>
                <option value="secondary">Secondary</option>
                <option value="success">Success</option>
                <option value="info">Info</option>
                <option value="warning">Warning</option>
                <option value="danger">Danger</option>
            </o-select>
        </o-field>
        <o-field label="Size">
            <o-select v-model="size" expanded>
                <option value="">Default</option>
                <option value="small">small</option>
                <option value="medium">medium</option>
                <option value="large">large</option>
            </o-select>
        </o-field>
    </o-field>

    <o-switch
        :rounded="isRounded"
        :position="position"
        :size="size"
        :variant="variant"
        :passive-variant="passive"
        label="Sample" />
</section>

JS

import { ref } from "vue";

const size = ref("");
const variant = ref<string>();
const passive = ref<string>();
const isRounded = ref(false);
const position = ref("right");

Switch Component

Switch between two opposing states.

<o-switch></o-switch>

Props

Prop name	Description	Type	Values	Default
autocomplete	Same as native autocomplete options to use in HTML5 validation	string	-	From config: switch: {   autocomplete: "off" }
customValidity	Custom HTML 5 validation error to set on the form control	string | ((currentValue: unknown, state: ValidityState) => string)	-
disabled	Same as native disabled	boolean	-	false
falseValue	Overrides the returned value when it's not checked	unknown	-
id	Same as native id. Also set the for label for o-field wrapper - default is an uuid.	string	-	useId()
label	Input label, unnecessary when default slot is used	string	-
v-model	The input value state, use v-model to make it two-way binding	unknown	-
name	Name attribute on native checkbox	string	-
nativeValue	Same as native value	unknown	-
override	Override existing theme classes completely	boolean	-
passiveVariant	Color of the switch when is passive	string	primary, info, success, warning, danger, and any other custom color	From config: switch: {   passiveVariant: undefined }
position	Label position	string	-	From config: switch: {   right: "position" }
required	Same as native required	boolean	-	false
rounded	Rounded style	boolean	-	From config: switch: {   rounded: true }
size	Size of the control	string	small, medium, large	From config: switch: {   size: undefined }
trueValue	Overrides the returned value when it's checked	unknown	-
useHtml5Validation	Enable html 5 native validation	boolean	-	From config: {   useHtml5Validation: true }
variant	Color of the control	string	primary, info, success, warning, danger, and any other custom color	From config: switch: {   variant: undefined }

Events

Event name	Properties	Description
update:model-value	value unknown - updated modelValue prop	modelValue prop two-way binding
input	value unknown - input value event Event - native event	on input change event
focus	event Event - native event	on input focus event
blur	event Event - native event	on input blur event
invalid	event Event - native event	on input invalid event

Slots

Name	Description	Bindings
default	Override the label, default is label prop

Class Inspector

Classes applied to the element:

How does the Class props inspector work?

Class props inspector is useful to see class props you want to use to customize Oruga components and how they change a component. You can click on Inspect button to find the exact element where a specific class prop acts.

In the Class props inspector there are other columns:

Class prop

This column contains the name of the Class prop you want to inspect.
If you find a name with a link ( ▷ classPropName) this refers to a subitem (e.g. Dropdown Item in Dropdown).

Description

This column contains the description of the Class prop you want to inspect.
👉 This icon indicates some warning, e.g. this Class prop is visible only on mobile.

Props

This column contains a list of props that activate the class, e.g. if a class prop contains disabled prop it means that only when the component has disabled prop.

Suffixes

This column contains all the possible suffixes that you'll receive if you use a function to customize your Class prop.

Class prop	Description	Props	Suffixes
rootClass	Class of the root element.
checkedClass	Class of the root element when checked.	modelValue
sizeClass	Class of the root element with size.	size	small medium large
variantClass	Class of the root element with variant.	variant	primary info warning danger
passiveVariantClass	Class of the root element with passive variant.	passiveVariant	primary info warning danger
positionClass	Class of the root element with position.	position
disabledClass	Class of the root element when disabled.	disabled
roundedClass	Class of the root element when rounded.	rounded
inputClass	Class of the native input element.
labelClass	Class of the switch label element.

Sass Variables

Current theme ➜ Oruga

SASS Variable	Default
$switch-spacer	0.5em
$switch-width	2.75em
$switch-height	1.5em
$switch-background	var(--#{$prefix}grey-light)
$switch-toggle-background	$control-brackground-color
$switch-border	$control-border-width solid var(--#{$prefix}grey-lighter)
$switch-border-radius	var(--#{$prefix}base-border-radius)
$switch-border-radius-rounded	var( --#{$prefix}base-border-radius-rounded)
$switch-checked-background	var(--#{$prefix}primary)
$switch-disabled-opacity	var(--#{$prefix}base-disabled-opacity)

See ➜ 📄 SCSS file

Current theme ➜ Bulma

SASS Variable	Default
$switch-width	2.75em
$switch-padding	0.2em
$switch-colors	dv.$colors
$switch-background-color	css.getVar("grey-light")
$switch-active-background-color	css.getVar("primary")
$switch-shadow	css.getVar("shadow")

See ➜ 📄 SCSS file

Current theme ➜ Bootstrap

SASS Variable	Default
$switch-spacer	0.5em
$switch-width	2.75em
$switch-height	1.5em

See ➜ 📄 SCSS file