charton

Appearance

charton API

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

Interface: InputContext<V> ​

Defined in: ui/src/form-inputs.ts:27

What the form hands a renderer.

Type Parameters ​

V ​

V = unknown

Properties ​

controlId ​

readonly controlId: string

Defined in: ui/src/form-inputs.ts:29

Put this id on the focusable control; the field's label points at it.

labelId ​

readonly labelId: string

Defined in: ui/src/form-inputs.ts:31

Id of the field's label, for controls labelled with aria-labelledby (groups).

localization? ​

readonly optional localization?: Localizer

Defined in: ui/src/form-inputs.ts:39

The language of the dialog (its localization option), for the control's own text.

value ​

readonly value: V

Defined in: ui/src/form-inputs.ts:33

Value when the control is created.

values ​

readonly values: Readonly<FormValues>

Defined in: ui/src/form-inputs.ts:35

Current values of the whole form.

Methods ​

set() ​

set(value): void

Defined in: ui/src/form-inputs.ts:37

Report a value the user entered; the form validates it and updates the preview.

Parameters ​

value ​

V

Returns ​

void