charton

Appearance

charton API

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

Interface: FormDialog ​

Defined in: ui/src/form-dialog.ts:68

An open form dialog made by createFormDialog: reads its values and errors, switches sections, and submits, cancels or closes it.

Properties ​

el ​

readonly el: HTMLElement

Defined in: ui/src/form-dialog.ts:70

Backdrop that holds the dialog.

errors ​

readonly errors: Readonly<Record<string, string>>

Defined in: ui/src/form-dialog.ts:75

Messages of the visible, enabled inputs that are not valid, by input id.

isOpen ​

readonly isOpen: boolean

Defined in: ui/src/form-dialog.ts:71

section ​

readonly section: string

Defined in: ui/src/form-dialog.ts:77

Id of the section shown.

values ​

readonly values: FormValues

Defined in: ui/src/form-dialog.ts:73

A copy of the current values.

Methods ​

cancel() ​

cancel(): void

Defined in: ui/src/form-dialog.ts:84

Restore the opening values (through onChange) and close.

Returns ​

void

close() ​

close(): void

Defined in: ui/src/form-dialog.ts:86

Close without restoring anything or calling callbacks.

Returns ​

void

setValues() ​

setValues(patch): void

Defined in: ui/src/form-dialog.ts:80

Change values from code. Calls no callbacks.

Parameters ​

patch ​

FormValues

Returns ​

void

showSection() ​

showSection(id): void

Defined in: ui/src/form-dialog.ts:78

Parameters ​

id ​

string

Returns ​

void

submit() ​

submit(): boolean

Defined in: ui/src/form-dialog.ts:82

Run the submit action: validate, then close unless onAction returns false. Returns whether it closed.

Returns ​

boolean