Interface FormOptions

interface FormOptions {
    idPrefix: string;
    live?: boolean;
    openOverlay?: (el: HTMLElement, opts?: OverlayOptions) => () => void;
    preserveInvalidNumbers?: boolean;
    translate?: WidgetTranslator;
    values: Readonly<Record<string, unknown>>;
    custom(control: FormControl, row: HTMLElement): null | HTMLElement;
    onChange(key: string, value: unknown): void;
    unavailable(key: string, option?: string): null | string;
}

Hierarchy (View Summary)

Properties

idPrefix live? openOverlay? preserveInvalidNumbers? translate? values

Methods

custom? onChange unavailable?

Properties

idPrefix

idPrefix: string

Prefix for element ids, so two forms in one document never share one.

Optionallive

live?: boolean

Emit colour and slider edits on input as well as change, for a dialog that previews live. Off, a colour is one edit when the picker closes and a slider one edit on release, which is what a per-edit undo history wants.

OptionalopenOverlay

openOverlay?: (el: HTMLElement, opts?: OverlayOptions) => () => void

Shared overlay owner for nested colour pickers.

Type declaration

    • (el: HTMLElement, opts?: OverlayOptions): () => void

    • Show el over the widget: positioned from opts.anchor (or centred as a dialog), focus-trapped, closed by Escape and by a press outside. Returns the closer.

      Parameters

      Returns () => void

OptionalpreserveInvalidNumbers

preserveInvalidNumbers?: boolean

Keep an invalid numeric draft visible for validation when a form is saved.

Optionaltranslate

translate?: WidgetTranslator

Translates widget-owned text. Omit to preserve English rendering.

values

values: Readonly<Record<string, unknown>>

Methods

Optionalcustom

  • custom(control: FormControl, row: HTMLElement): null | HTMLElement

  • Renders the control column of a custom row. Null skips the row.

    Parameters

    Returns null | HTMLElement

onChange

  • onChange(key: string, value: unknown): void

  • Every edit, with the value in the control's declared type.

    Parameters

    • key: string
    • value: unknown

    Returns void

Optionalunavailable

  • unavailable(key: string, option?: string): null | string

  • Why a control, or one option of a select, cannot act right now, or null when it can. Drawn disabled with the reason as its title, never hidden: a greyed row is information, an absent one is a mystery. Asked again after every edit and every sync, beside the control's activeWhen, and its reason wins where both apply because the host knows the context.

    Parameters

    • key: string
    • Optionaloption: string

    Returns null | string

Settings

Member Visibility

On This Page

Properties
Methods