Quartz Headless docs/CheckboxDirective

Search documentation

Type to search the documentation.

API: Primitives

CheckboxDirective

Directive reference for CheckboxDirective with the selector button[qzCheckbox].

Overview

Selector

button[qzCheckbox]

Inputs

Input Type Default Required Description
disabled unknown false Transform booleanAttribute; reads as boolean.

Models

Two-way bindings: each model is an input and emits the matching change output.

Model Type Default Required Change output Description
checked CheckboxState false checkedChange

Outputs

Output Payload Description
checkedChangeCommitted CheckboxState

Properties

Name Type Description
readonly isDisabled Signal<boolean> Effective disabled state: the disabled input OR a disabled Angular Forms control.
readonly state Signal<"indeterminate" | "checked" | "unchecked">
readonly ariaChecked Signal<CheckboxState | "mixed">

Public methods

toggle

toggle(event?: Event): void
Parameter Type Optional Description
event Event Yes

setFormDisabled

setFormDisabled(disabled: boolean): void

Adapter hook for @quartz-headless/primitives/forms (setDisabledState).

Parameter Type Optional Description
disabled boolean

onKeydown

onKeydown(event: KeyboardEvent): void
Parameter Type Optional Description
event KeyboardEvent