Switch¶

Usage¶

When to use¶

Use a si-switch component when there is a binary state that the user should be able to toggle instantly.

Examples are: On/Off, Online/Offline or Installed/Not installed.

Switches immediately trigger an effect when being clicked.

Dos and don'ts¶

• A label next to the switch must describe the affected property.
• Don't use the label to describe the states of the switch.
• A switch never needs an extra button to submit the selected state.

Design¶

A switch consists of the following elements:

1. Background, 2. Switch element

Background¶

Its appearance depends on the current state of the switch.

Switch element¶

• Shown on the right side for state On.
• Shown on the left side for state Off.

Code¶

In Element, switches are native <input type="checkbox"> elements with extra styling. They should be used together with the si-form-item component (see here).

A checkbox is turned into a switch by applying the form-switch class to the si-form-item component:

<si-form-item label="Switch" class="form-switch">
  <input type="checkbox" class="form-check-input" [formControl]="control">
</si-form-item>

The class form-check-input and type="checkbox" must be applied to ensure correct visual appearance. Instead of formControl, you can also use ngModel.

Group switches¶

Use the si-form-fieldset component to group multiple switches together. It will ensure a correct layout and apply the necessary accessibility attributes.

<si-form-fieldset label="Group">
  <si-form-item label="Option 1" class="form-switch">
    <input type="checkbox" class="form-check-input" [formControl]="control1">
  </si-form-item>
  <si-form-item label="Option 2">
    <input type="checkbox" class="form-check-input" [formControl]="control2">
  </si-form-item>
</si-form-fieldset>

By default, the switches are stacked vertically. To display them inline, apply the form-check-inline class to the si-form-item:

<si-form-fieldset label="Group Inline">
  <si-form-item label="Option 1" class="form-check-inline form-switch">
    <input type="checkbox" class="form-check-input" [formControl]="control1">
  </si-form-item>
  <si-form-item label="Option 2" class="form-check-inline form-switch">
    <input type="checkbox" class="form-check-input" [formControl]="control2">
  </si-form-item>
</si-form-fieldset>

Native HTML markup¶

If a si-form-item component cannot be used, it is also possible to use a switch with native HTML elements only:

<div class="form-check form-switch">
  <input type="checkbox" id="check-id" class="form-check-input">
  <label for="check-id" class="form-check-label">Switch</label>
</div>

In this case, all the attributes shown above must be set by an application. Otherwise, the switch may appear broken.

To create an inline switch, additionally apply the form-check-inline class to the form-check div.

Example¶