Skip to main content
Version: v8



Toggles are switches that change the state of a single option. They can be switched on or off by pressing or swiping them. Toggles can also be checked programmatically by setting the checked property.

Basic Usage

On / Off Labels

Toggles can enable on/off labels by setting the enableOnOffLabels property. This is important for accessibility as it makes it easier to differentiate between a checked and unchecked toggle.

Toggles in a List

Toggles can also be used in a list view by using the Item and List components.

Label Placement

Developers can use the labelPlacement property to control how the label is placed relative to the control.


Developers can use the alignment property to control how the label and control are aligned on the cross axis. This property mirrors the flexbox align-items property.


Stacked toggles can be aligned using the alignment property. This can be useful when the label and control need to be centered horizontally.


Developers can use the justify property to control how the label and control are packed on a line.



CSS Custom Properties

CSS custom properties can be combined with standard CSS to target different parts of a toggle. We can modify the width and height of the toggle directly to change the size of the track, while using the --handle-width and --handle-height custom properties to customize the handle size.

CSS Shadow Parts

We can further customize toggle by targeting specific shadow parts that are exposed. Any CSS property on these parts can be styled and they can also be combined with CSS custom properties.

Migrating from Legacy Toggle Syntax

A simpler toggle syntax was introduced in Ionic 7.0. This new syntax reduces the boilerplate required to setup an toggle, resolves accessibility issues, and improves the developer experience.

While developers can continue using the legacy syntax, we recommend migrating as soon as possible.

Using the Modern Syntax

Using the modern syntax involves removing the ion-label and passing the label directly inside of ion-toggle. The placement of the label can be configured using the labelPlacement property on ion-toggle. The way the label and the control are packed on a line can be controlled using the justify property on ion-toggle.

<!-- Basic -->

<!-- Before -->

<!-- After -->

<!-- Fixed Labels -->

<!-- Before -->
<ion-label position="fixed">Notifications</ion-label>

<!-- After -->
<ion-toggle label-placement="fixed">Notifications</ion-toggle>

<!-- Toggle at the start of line, Label at the end of line -->

<!-- Before -->
<ion-label slot="end">Notifications</ion-label>

<!-- After -->
<ion-toggle label-placement="end">Notifications</ion-toggle>

In past versions of Ionic, ion-item was required for ion-toggle to function properly. Starting in Ionic 7.0, ion-toggle should only be used in an ion-item when the item is placed in an ion-list. Additionally, ion-item is no longer required for ion-toggle to function properly.

Using the Legacy Syntax

Ionic uses heuristics to detect if an app is using the modern toggle syntax. In some instances, it may be preferable to continue using the legacy syntax. Developers can set the legacy property on ion-toggle to true to force that instance of the toggle to use the legacy syntax.



interface ToggleChangeEventDetail<T = any> {
value: T;
checked: boolean;


While not required, this interface can be used in place of the CustomEvent interface for stronger typing with Ionic events emitted from this component.

interface ToggleCustomEvent<T = any> extends CustomEvent {
detail: ToggleChangeEventDetail<T>;
target: HTMLIonToggleElement;



DescriptionHow to control the alignment of the toggle and label on the cross axis. "start": The label and control will appear on the left of the cross axis in LTR, and on the right side in RTL. "center": The label and control will appear at the center of the cross axis in both LTR and RTL.
Type"center" | "start"


DescriptionIf true, the toggle is selected.


DescriptionThe color to use from your application's color palette. Default options are: "primary", "secondary", "tertiary", "success", "warning", "danger", "light", "medium", and "dark". For more information on colors, see theming.
Type"danger" | "dark" | "light" | "medium" | "primary" | "secondary" | "success" | "tertiary" | "warning" | string | undefined


DescriptionIf true, the user cannot interact with the toggle.


DescriptionEnables the on/off accessibility switch labels within the toggle.
Typeboolean | undefined


DescriptionHow to pack the label and toggle within a line. "start": The label and toggle will appear on the left in LTR and on the right in RTL. "end": The label and toggle will appear on the right in LTR and on the left in RTL. "space-between": The label and toggle will appear on opposite ends of the line with space between the two elements.
Type"end" | "space-between" | "start"


DescriptionWhere to place the label relative to the input. "start": The label will appear to the left of the toggle in LTR and to the right in RTL. "end": The label will appear to the right of the toggle in LTR and to the left in RTL. "fixed": The label has the same behavior as "start" except it also has a fixed width. Long text will be truncated with ellipses ("..."). "stacked": The label will appear above the toggle regardless of the direction. The alignment of the label can be controlled with the alignment property.
Type"end" | "fixed" | "stacked" | "start"


DescriptionThe mode determines which platform styles to use.
Type"ios" | "md"


DescriptionThe name of the control, which is submitted with the form data.


DescriptionThe value of the toggle does not mean if it's checked or not, use the checked property for that.

The value of a toggle is analogous to the value of a <input type="checkbox">, it's only used when the toggle participates in a native <form>.
Typenull | string | undefined


ionBlurEmitted when the toggle loses focus.true
ionChangeEmitted when the user switches the toggle on or off. Does not emit when programmatically changing the value of the checked property.true
ionFocusEmitted when the toggle has focus.true


No public methods available for this component.

CSS Shadow Parts

handleThe toggle handle, or knob, used to change the checked state.
labelThe label text describing the toggle.
trackThe background track of the toggle.

CSS Custom Properties

--border-radiusBorder radius of the toggle track
--handle-backgroundBackground of the toggle handle
--handle-background-checkedBackground of the toggle handle when checked
--handle-border-radiusBorder radius of the toggle handle
--handle-box-shadowBox shadow of the toggle handle
--handle-heightHeight of the toggle handle
--handle-max-heightMaximum height of the toggle handle
--handle-spacingHorizontal spacing around the toggle handle
--handle-transitionTransition of the toggle handle
--handle-widthWidth of the toggle handle
--track-backgroundBackground of the toggle track
--track-background-checkedBackground of the toggle track when checked


``The label text to associate with the toggle. Use the "labelPlacement" property to control where the label is placed relative to the toggle.