charton

Appearance

charton API

charton API / @chart-on/ui / index / BooleanInputDef

Interface: BooleanInputDef ​

Defined in: ui/src/form-model.ts:57

An on/off checkbox (kind: 'boolean').

Extends ​

Properties ​

default? ​

optional default?: boolean

Defined in: ui/src/form-model.ts:28

Value when the form opens without one, and after a reset.

Inherited from ​

FormInputBase.default

disabled? ​

optional disabled?: FormCondition

Defined in: ui/src/form-model.ts:32

Default false. Disabled inputs keep their value and are not validated.

Inherited from ​

FormInputBase.disabled

hint? ​

optional hint?: string

Defined in: ui/src/form-model.ts:26

Help text under the control.

Inherited from ​

FormInputBase.hint

id ​

id: string

Defined in: ui/src/form-model.ts:23

Key of this input's value in FormValues; unique within the schema.

Inherited from ​

FormInputBase.id

kind ​

kind: "boolean"

Defined in: ui/src/form-model.ts:58

label ​

label: string

Defined in: ui/src/form-model.ts:24

Inherited from ​

FormInputBase.label

visible? ​

optional visible?: FormCondition

Defined in: ui/src/form-model.ts:30

Default true. Hidden inputs keep their value and are not validated.

Inherited from ​

FormInputBase.visible

Methods ​

validate()? ​

optional validate(value, values): string | null | undefined

Defined in: ui/src/form-model.ts:34

A message when value is not acceptable, else nothing. Runs after the built-in checks pass.

Parameters ​

value ​

boolean

values ​

Readonly<FormValues>

Returns ​

string | null | undefined

Inherited from ​

FormInputBase.validate