CheckboxOptions

Defined in: components/checkbox.ts:6

Options for checkbox.

Extends

Omit<FieldOptions, "label">

Properties

label?

optional label?: Slot

Defined in: components/checkbox.ts:8

The label shown next to the box. Required for a meaningful checkbox.

bind?

optional bind?: Bindable<boolean>

Defined in: components/checkbox.ts:10

Two-way binding target holding a boolean.

checked?

optional checked?: boolean

Defined in: components/checkbox.ts:12

Static initial checked state.

change?

optional change?: (event) => void

Defined in: components/checkbox.ts:14

Fired on change with the native event.

Parameters

event

Event

Returns

void

attrs?

optional attrs?: string

Defined in: components/field.ts:14

Aberdeen attr/style string applied to the field’s wrapper element.

Inherited from

FieldOptions.attrs

help?

optional help?: Slot

Defined in: components/field.ts:18

Helper text shown beneath the control.

Inherited from

FieldOptions.help

error?

optional error?: string

Defined in: components/field.ts:23

Error message shown beneath the control. When set, the control is marked aria-invalid and styled accordingly. May be reactive.

Inherited from

FieldOptions.error

disabled?

optional disabled?: boolean

Defined in: components/field.ts:25

Disables the control.

Inherited from

FieldOptions.disabled

required?

optional required?: boolean

Defined in: components/field.ts:27

Marks the field required (adds a * and the aria-required attribute).

Inherited from

FieldOptions.required

name?

optional name?: string

Defined in: components/field.ts:29

The name attribute, for native form submission.

Inherited from

FieldOptions.name

id?

optional id?: string

Defined in: components/field.ts:31

Explicit id for the control; auto-generated when omitted.

Inherited from

FieldOptions.id

inputAttrs?

optional inputAttrs?: string

Defined in: components/field.ts:33

Aberdeen attr/style string applied to the control (input) element itself.

Inherited from

FieldOptions.inputAttrs