Checkbox

Perform state toggling.

Usage

Assemble the checkbox directives in your template.

<button ngpCheckbox [(ngpCheckboxChecked)]="checked">
  <ng-icon ngpCheckboxIndicator name="checkmark" />
</button>

API Reference

The following directives are available to import from the @ng-primitives/ng-primitives/checkbox package:

NgpCheckboxDirective

ngpCheckboxChecked · boolean · default: "false"

Define the checked state.

ngpCheckboxIndeterminate · boolean · default: "false"

Define the interminate state.

ngpCheckboxDisabled · boolean · default: "false"

Define the disabled state.

ngpCheckboxCheckedChange · boolean

Event emitted when the state changes.

ngpCheckboxIndeterminateChange · boolean

Event emitted when the indeterminate state changes.

NgpCheckboxIndicatorDirective

There are no inputs or outputs for this directive.

Schematics

You can use our schematic to generate a new checkbox component.

Angular CLI

ng generate @ng-primitives/ng-primitives:checkbox

Options

name · string

The name of the component.

project · string

The name of the project to add the component to.

path · string

The path to create the component.