Vizel API / core/src / VizelFormSpec

Interface: VizelFormSpec<TFields>

Defined in: packages/core/src/builders/types.ts:271

Spec for an inline input form.

Used by link editor ({ url, text, embed }), find/replace ({ find, replace }), and future forms. The TFields type parameter constrains the field map so consumers get type-safe access to each named field.

Type Parameters

Type Parameter
TFields extends Record<string, VizelFormFieldSpec<unknown>>

Properties

cancelLabel?

readonly optional cancelLabel?: string;

Defined in: packages/core/src/builders/types.ts:277

Localized cancel-button label, when the form supports cancel.

---

canSubmit

readonly canSubmit: boolean;

Defined in: packages/core/src/builders/types.ts:279

Whether the submit action is currently allowed.

---

fields

readonly fields: TFields;

Defined in: packages/core/src/builders/types.ts:273

---

root

readonly root: VizelFormRootAttrs;

Defined in: packages/core/src/builders/types.ts:272

---

submitLabel

readonly submitLabel: string;

Defined in: packages/core/src/builders/types.ts:275

Localized submit-button label.