Toggle | Quasar Framework

Toggle

The QToggle component is another basic element for user input. You can use this for turning settings, features or true/false inputs on and off.

TIP

Please also refer to the QOptionGroup on other possibilities for creating groups of Checkboxes.

QToggle API

Usage

Basic

Use the color prop to control the toggle’s color.

With labels

Keeping color

With icons

Custom model values

Instead of the default true/false values, you can use custom ones.

Indeterminate state
v1.8+

In the example below, as soon as you click on the first QToggle it starts toggling between true/false. The second QToggle, on the other hand toggles between the three states (indeterminate/true/false) with help from toggle-indeterminate. You can optionally set the property indeterminate-value, otherwise the indeterminate value will be considered null.

Toggle order
v1.12+

By default, QToggle follows this chain when toggling: indeterminate -> checked -> unchecked. However, you can change this behavior through the toggle-order prop. This property determines the order of the states and can be tf (default) or ft (t stands for state of true/checked while f for state of false/unchecked).

Toggling order is:

if toggle-indeterminate is true, then: indet -> first state -> second state -> indet (and repeat)
otherwise (no toggle-indeterminate): indet -> first state -> second state -> first state -> second state -> …

Array model

If you have a number of toggles for a selection, use can use an Array as the model for all of them and specify val prop on each toggle. If the toggle is ticked, its val will be inserted into the array and vice versa.

Dark and disable

Sizes
v1.8+

Apart from the standard sizes below, you can define your own through the size property (last one is a custom size).

With QOptionGroup

TIP

You can also use QOptionGroup, which simplifies the usage when you have groups of toggles, like in example below.

With QItem

Native form submit
v1.9+

When dealing with a native form which has an action and a method (eg. when using Quasar with ASP.NET controllers), you need to specify the name property on QToggle, otherwise formData will not contain it (if it should) - all value are converted to string (native behaviour, so do not use Object values):

Ready for more?