Heroic Lands

Interface DialogSpec

Configuration for the single generic dialog boundary function — the one logic-level dialog primitive (supersedes the former per-shape helpers).

interface DialogSpec {
    buttons?: sohl.core.DialogButtonSpec[];
    callback?: sohl.core.DialogResultCallback;
    content?: HTMLString;
    data?: PlainObject;
    modal?: boolean;
    rejectClose?: boolean;
    render?: DialogRenderCallback;
    template?: FilePath;
    title?: string;
}

Properties

buttons? callback? content? data? modal? rejectClose? render? template? title?

Properties

Optionalbuttons

buttons?: sohl.core.DialogButtonSpec[]

Buttons to show; defaults to a single confirming ok button.

Optionalcallback

callback?: sohl.core.DialogResultCallback

Pure result-builder; see DialogResultCallback.

Optionalcontent

content?: HTMLString

Inline HTML body used when no template is given.

Optionaldata

data?: PlainObject

Data passed to the template/content during rendering.

Optionalmodal

modal?: boolean

Whether the dialog blocks interaction with the rest of the UI.

OptionalrejectClose

rejectClose?: boolean

Whether dismissal rejects instead of resolving to null.

Optionalrender

render?: DialogRenderCallback

Invoked after the dialog renders and on every re-render; see DialogRenderCallback. Use it to wire dynamic form behaviour, e.g. recomputing dependent fields when a dropdown value changes.

Optionaltemplate

template?: FilePath

Handlebars template rendered for the body (takes precedence over content).

Optionaltitle

title?: string

Dialog window title.

Settings

Member Visibility

On This Page

Properties