Checkbox

Checkbox is an extension to standard checkbox element with theming.

Import #


import { CheckboxModule } from 'primeng/checkbox';

Basic #

Binary checkbox is used as a controlled input with ngModel and binary properties.



<p-checkbox [(ngModel)]="checked" [binary]="true" inputId="binary"></p-checkbox>

Reactive Forms #

Checkbox can also be used with reactive forms. In this case, the formControlName property is used to bind the component to a form control.



<form class="flex align-items-center gap-1" [formGroup]="formGroup">
    <p-checkbox formControlName="city" value="New York" inputId="ny"></p-checkbox>
    <label for="ny">New York</label>
</form>

Group #

Multiple checkboxes can be grouped together.



<div class="flex align-items-center gap-1">
        <p-checkbox name="group1" value="New York" [(ngModel)]="selectedCities" inputId="ny"></p-checkbox>
        <label for="ny">New York</label>
</div>

<div class="flex align-items-center gap-1">
    <p-checkbox name="group1" value="San Francisco" [(ngModel)]="selectedCities" inputId="sf"></p-checkbox>
    <label for="sf">San Francisco</label>
</div>

<div class="flex align-items-center gap-1">
    <p-checkbox name="group1" value="Los Angeles" [(ngModel)]="selectedCities" inputId="la"></p-checkbox>
    <label for="la">Los Angeles</label>
</div>

Label #

The label attribute provides a label text for the checkbox. This label is also clickable and toggles the checked state.



<p-checkbox name="groupname" value="val1" label="Value 1" [(ngModel)]="selectedValues"></p-checkbox>
<p-checkbox name="groupname" value="val2" label="Value 2" [(ngModel)]="selectedValues"></p-checkbox>

Dynamic #

Checkboxes can be generated using a list of values.



<div *ngFor="let category of categories" class="field-checkbox">
    <p-checkbox name="group" [value]="category" [(ngModel)]="selectedCategories" [inputId]="category.key"></p-checkbox>
    <label [for]="category.key">{{ category.name }}</label>
</div>

Disabled #

When disabled is present, the element cannot be edited and focused.



<p-checkbox [disabled]="true" [(ngModel)]="checked"></p-checkbox>

Style #

Following is the list of structural style classes, for theming classes visit theming page.

NameElement
p-checkboxContainer element
p-checkbox-boxContainer of icon.
p-checkbox-iconIcon element.
p-checkbox-labelLabel element.
p-label-activeLabel element of a checked state.
p-label-focusLabel element of a focused state.
p-label-disabledLabel element of a disabled state.
Accessibility guide documents the specification of this component based on WCAG guidelines, the implementation is in progress.

Accessibility #

Screen Reader

Checkbox component uses a hidden native checkbox element internally that is only visible to screen readers. Value to describe the component can either be provided via label tag combined with inputId prop or using aria-labelledby, aria-label props. 


<label for="chkbox1">Remember Me</label>
<p-checkbox inputId="chkbox1"></p-checkbox>

<span id="chkbox2">Remember Me</span>
<p-checkbox aria-labelledby="chkbox2"></p-checkbox>

<p-checkbox aria-label="Remember Me"></p-checkbox>

Keyboard Support

KeyFunction
tabMoves focus to the checkbox.
spaceToggles the checked state.
PrimeNG 16.0.0-rc.2 by PrimeTek