interface / @typed/ui

Form.CheckboxOptions

Options for a state-explicit native checkbox.

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
Component options
Since
1.0.0
Member of
Form

Import

import { Form } from "@typed/ui";

Access Form.CheckboxOptions through the imported Form export. Its declaration below describes the member.

This public exposure is a re-export. Its import path is supported; declaration documentation is shared with the other public exposures below.

Signatures

export interface CheckboxOptions<Values extends object> extends Dom.HostOptions<HTMLInputElement> {
    readonly state: FormState<Values>;
    readonly name: BooleanFieldName<Values>;
}

Property: name

Boolean field controlled by the checkbox.

Property: state

Renderer-independent state read and updated by the checkbox.

Other public imports

These import paths expose the same declaration. Each page retains its own public name and signature.

Source