Zur Navigation Zum Inhalt Kontakt Menu Find component Overview Lyne Principles Foundation Accessibility Design System Guidelines Deutsch Français Italiano English Our design principles User-centred Recognisable Inclusive Reduced Holistic Self-explanatory Task-oriented Appropriate SBB Brand portal Logo Digital clock Rights of use Base colors Functional colors Off brand colors Icons Timetable icons Pictograms About accessibility Über diesen Guide Contact Further information Product Owner User Research Interaction Design Visual Design Development Content Design Testing What is a design system? Designing Coding FAQ Help Process Contribution Contact Overview Base Components Overview Base Components Overview Base Components Overview Releases Design Tokens Komponenten Overview Base Informationen Sense & Purpose Community Assets Instructions Power-Apps Digital banner ads SAP Design Guidelines App Icons Toggle-Check Implementation

The sbb-toggle-check is a component which provides the same functionality as a native <input type="checkbox" />
enhanced with the SBB Design.

<sbb-toggle-check name="check" value="single-checkbox">Example</sbb-toggle-check>

Slots

It is possible to provide a label via an unnamed slot; the component can optionally display a sbb-icon
using the iconName property or via custom content using the icon slot.
The icon can be at the component start or end based on the value of the labelPosition property (default: after).

<sbb-toggle-check name="check" value="single-checkbox" icon-name="pie-small">
  Example
</sbb-toggle-check>

<sbb-toggle-check name="other" value="single-checkbox" icon-name="pie-small" label-position="start">
  Another example
</sbb-toggle-check>

States

The component can be displayed in checked or disabled states using the self-named properties.

<sbb-toggle-check name="check" value="Value" checked>Option</sbb-toggle-check>

<sbb-toggle-check name="other" value="Value" disabled>Option</sbb-toggle-check>

Events

Consumers can listen to the native change event on the sbb-toggle-check component to intercept the input's change;
the current state can be read from event.target.checked and the value from event.target.value.

Accessibility

The component provides the same accessibility features as the native checkbox.

Avoid adding other interactive controls into the content of sbb-toggle-check, as this degrades the experience for users of assistive technology.

If you don't want the label to appear next to the sbb-toggle-check component,
you can not provide it and then use aria-label to specify an appropriate label for screen-readers.

<sbb-toggle-check aria-label="Subscribed to email message"></sbb-toggle-check>

Properties

Name Attribute Privacy Type Default Description
size size public 's' | 'm' 's' Size variant, either m or s.
iconName icon-name public string | undefined 'tick-small' The svg name for the true state - default -> 'tick-small'
labelPosition label-position public 'before' | 'after' | undefined 'after' The label position relative to the toggle. Defaults to 'after'
checked checked public boolean false Whether the checkbox is checked.
disabled disabled public boolean false Whether the component is disabled.
required required public boolean false Whether the component is required.
form - public HTMLFormElement | null Returns the form owner of internals target element.
name name public string Name of the form element. Will be read from name attribute.
value value public string | null null Value of the form element.

Events

Name Type Description Inherited From
didChange CustomEvent<void> Deprecated. used for React. Will probably be removed once React 19 is available.
change Event Event fired on change.
input InputEvent Event fired on input.

Slots

Name Description
Use the unnamed slot to add content to the toggle label.
icon Use this slot to provide an icon. If icon-name is set, a sbb-icon will be used.
Examples
Sbb Toggle Check Default
Sbb Toggle Check Default Size M
Sbb Toggle Check Default Checked
Sbb Toggle Check Default Long Label
Sbb Toggle Check Default Long Label Size M
Sbb Toggle Check Label Before
Sbb Toggle Check Without Label
Sbb Toggle Check Disabled
Sbb Toggle Check Disabled Checked
Sbb Toggle Check Custom Icon
Sbb Toggle Check Custom Icon Slotted
Sbb Toggle Check Block Variant
With Form
HTML-Markup kopiert.
Playground
Example
Disabled Nein Ja Icon Default Anderes Position Label Danach Davor Hintergrund White Milk Iron Charcoal Black
Imprint Contact Cookie settings