charton API

---

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

Interface: FormAction

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

A footer button. submit validates and closes, cancel restores the values the dialog opened with and closes, reset restores the inputs' defaults, and button only calls onAction.

Properties

align?

optional align?: "header" | "nav" | "end" | "start"

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

Default end; start puts it on the other side of the footer, header in the header beside the close button, and nav below the section list of a sidebar layout, for buttons that lead elsewhere (at the footer start when there is no sidebar: another layout, or compact mode).

---

id

id: string

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

---

label

label: string

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

---

labelKey?

optional labelKey?: string

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

Message key of the label, e.g. dialogOk: the dialog shows the key in its localization's language while label is still the key's English text.

---

role?

optional role?: "button" | "cancel" | "reset" | "submit"

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