Checkboxes allow the selection of multiple options from a set of options. They appear as checked (ticked) when activated. Clicking on a checkbox will toggle the checked property. They can also be checked programmatically by setting the checked property.
While not required, this interface can be used in place of the CustomEvent interface for stronger typing with Ionic events emitted from this component.
A simpler checkbox syntax was introduced in Ionic 7.0. This new syntax reduces the boilerplate required to setup a checkbox, resolves accessibility issues, and improves the developer experience.
Developers can perform this migration one checkbox at a time. While developers can continue using the legacy syntax, we recommend migrating as soon as possible.
Using the modern syntax involves removing the ion-label and passing the label directly inside of ion-checkbox. The placement of the label can be configured using the labelPlacement property on ion-checkbox. The way the label and the control are packed on a line can be controlled using the justify property on ion-checkbox.
JavaScript
Angular
React
Vue
<!-- Basic --> <!-- Before --> <ion-item> <ion-label>Checkbox Label</ion-label> <ion-checkbox></ion-checkbox> </ion-item> <!-- After --> <ion-item> <ion-checkbox>Checkbox Label</ion-checkbox> </ion-item> <!-- Fixed Labels --> <!-- Before --> <ion-item> <ion-labelposition="fixed">Checkbox Label</ion-label> <ion-checkbox></ion-checkbox> </ion-item> <!-- After --> <ion-item> <ion-checkboxlabel-placement="fixed">Checkbox Label</ion-checkbox> </ion-item> <!-- Checkbox at the start of line, Label at the end of line --> <!-- Before --> <ion-item> <ion-labelslot="end">Checkbox Label</ion-label> <ion-checkbox></ion-checkbox> </ion-item> <!-- After --> <ion-item> <ion-checkboxlabel-placement="end">Checkbox Label</ion-checkbox> </ion-item>
<!-- Basic --> <!-- Before --> <ion-item> <ion-label>Checkbox Label</ion-label> <ion-checkbox></ion-checkbox> </ion-item> <!-- After --> <ion-item> <ion-checkbox>Checkbox Label</ion-checkbox> </ion-item> <!-- Fixed Labels --> <!-- Before --> <ion-item> <ion-labelposition="fixed">Checkbox Label</ion-label> <ion-checkbox></ion-checkbox> </ion-item> <!-- After --> <ion-item> <ion-checkboxlabelPlacement="fixed">Checkbox Label</ion-checkbox> </ion-item> <!-- Checkbox at the start of line, Label at the end of line --> <!-- Before --> <ion-item> <ion-labelslot="end">Checkbox Label</ion-label> <ion-checkbox></ion-checkbox> </ion-item> <!-- After --> <ion-item> <ion-checkboxlabelPlacement="end">Checkbox Label</ion-checkbox> </ion-item>
{/* Basic */} {/* Before */} <IonItem> <IonLabel>CheckboxLabel</IonLabel> <IonCheckbox></IonCheckbox> </IonItem> {/* After */} <IonItem> <IonCheckbox>CheckboxLabel</IonCheckbox> </IonItem> {/* Fixed Labels */} {/* Before */} <IonItem> <IonLabelposition="fixed">CheckboxLabel</IonLabel> <IonCheckbox></IonCheckbox> </IonItem> {/* After */} <IonItem> <IonCheckboxlabelPlacement="fixed">CheckboxLabel</IonCheckbox> </IonItem> {/* Checkbox at the start of line, Label at the end of line */} {/* Before */} <IonItem> <IonLabelslot="end">CheckboxLabel</IonLabel> <IonCheckbox></IonCheckbox> </IonItem> {/* After */} <IonItem> <IonCheckboxlabelPlacement="end">CheckboxLabel</IonCheckbox> </IonItem>
<!-- Basic --> <!-- Before --> <ion-item> <ion-label>Checkbox Label</ion-label> <ion-checkbox></ion-checkbox> </ion-item> <!-- After --> <ion-item> <ion-checkbox>Checkbox Label</ion-checkbox> </ion-item> <!-- Fixed Labels --> <!-- Before --> <ion-item> <ion-labelposition="fixed">Checkbox Label</ion-label> <ion-checkbox></ion-checkbox> </ion-item> <!-- After --> <ion-item> <ion-checkboxlabel-placement="fixed">Checkbox Label</ion-checkbox> </ion-item> <!-- Checkbox at the start of line, Label at the end of line --> <!-- Before --> <ion-item> <ion-labelslot="end">Checkbox Label</ion-label> <ion-checkbox></ion-checkbox> </ion-item> <!-- After --> <ion-item> <ion-checkboxlabel-placement="end">Checkbox Label</ion-checkbox> </ion-item>
note
In past versions of Ionic, ion-item was required for ion-checkbox to function properly. Starting in Ionic 7.0, ion-checkbox 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-checkbox to function properly.
Ionic uses heuristics to detect if an app is using the modern checkbox syntax. In some instances, it may be preferable to continue using the legacy syntax. Developers can set the legacy property on ion-checkbox to true to force that instance of the checkbox to use the legacy syntax.
The 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.
How to pack the label and checkbox within a line. "start": The label and checkbox will appear on the left in LTR and on the right in RTL. "end": The label and checkbox will appear on the right in LTR and on the left in RTL. "space-between": The label and checkbox will appear on opposite ends of the line with space between the two elements.
Where to place the label relative to the checkbox. "start": The label will appear to the left of the checkbox in LTR and to the right in RTL. "end": The label will appear to the right of the checkbox 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 ("...").
Set the legacy property to true to forcibly use the legacy form control markup. Ionic will only opt checkboxes in to the modern form markup when they are using either the aria-label attribute or have text in the default slot. As a result, the legacy property should only be used as an escape hatch when you want to avoid this automatic opt-in behavior.
Note that this property will be removed in an upcoming major release of Ionic, and all form components will be opted-in to using the modern form markup.
Emitted when the checked property has changed as a result of a user action such as a click. This event will not emit when programmatically setting the checked property.