Skip to contentPorsche Design System
You are currently viewing an earlier release of the Porsche Design System.Switch to the latest Porsche Design System documentation.
SearchGitHub repository of Porsche Design SystemOpen settings sidebar
Switch Table of ContentsPropertiestype BreakpointCustomizable<T> = { base: T; xs?: T; s?: T; m?: T; l?: T; xl?: T; xxl?: T; };PropertyAttributeDescriptionTypeDefaultalignLabel 🛠align-labelSets the position of the slotted label relative to the switch toggle, either before (start) or after (end) it. Supports responsive breakpoint values.type SwitchAlignLabel =
'start'
'end'
BreakpointCustomizable<SwitchAlignLabel>'end'checked checkedReflects the switch's current on/off state and allows setting the initial checked value when the component first renders.booleanfalsecompact compactReduces the switch size and spacing for use in dense layouts where vertical space is limited.booleanfalsedisabled disabledPrevents user interaction with the switch and blocks all click and keyboard events while it is disabled.booleanfalsehideLabel 🛠hide-labelHides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.boolean
BreakpointCustomizable<boolean>falseloading loadingDisables the switch and shows a loading spinner to indicate an ongoing asynchronous toggle operation.booleanfalsestretch 🛠stretchExpands the space between the switch toggle and its label to fill the full available width of the container. Supports responsive breakpoint values.boolean
BreakpointCustomizable<boolean>falseEventsEventDescriptionTypeupdate Emitted when the user toggles the switch, carrying the new checked state in the event detail.type SwitchUpdateEventDetail = {
  checked: boolean;
}
CustomEvent<SwitchUpdateEventDetail>SlotsSlotDescriptionisRequiredaltPropallowedTagNames<slot> Default slot for the label.
Global settingsColor SchemeAll color tokens use the light-dark() CSS function. Set the theme via the CSS color-scheme property: light for light mode, dark for dark mode, or light dark to follow the user's system preference.LightDarkLight DarkDirectionThe dir global attribute in HTML changes the direction of text and other content within an element. It's most often used on the <html> tag to set the entire page's direction, which is crucial for supporting languages that are written from right to left (RTL), such as Arabic and Hebrew. For example, using <html dir="rtl"> makes the entire page display from right to left, adjusting the layout and text flow accordingly.LTR (left-to-right)RTL (right-to-left)Text ZoomTo ensure accessibility and comply with WCAG 2.2 AA standards, it is mandatory for web content to support text resizing up to at least 200% without loss of content or functionality. Using relative units like rem is a best practice for achieving this, as they allow the text to scale uniformly based on the user's browser settings.100%130%150%200%