Interface ITextOptions

Constructor options for text input dialogs

interface ITextOptions {
    cancelLabel?: string;
    checkbox?: null | Partial<ICheckbox>;
    defaultButton?: number;
    host?: HTMLElement;
    label?: string;
    okLabel?: string;
    pattern?: string;
    placeholder?: string;
    prefix?: string;
    renderer?: Dialog.IRenderer;
    required?: boolean;
    selectionRange?: number;
    suffix?: string;
    text?: string;
    title: Header;
}

Hierarchy (view full)

Properties

cancelLabel? checkbox? defaultButton? host? label? okLabel? pattern? placeholder? prefix? renderer? required? selectionRange? suffix? text? title

Properties

Optional cancelLabel

cancelLabel?: string

Label for cancel button.

Optional checkbox

checkbox?: null | Partial<ICheckbox>

The checkbox to display in the footer. Defaults no checkbox.

Optional defaultButton

defaultButton?: number

The index of the default button. Defaults to the last button.

Optional host

host?: HTMLElement

The host element for the dialog. Defaults to document.body.

Optional label

label?: string

Label of the requested input

Optional okLabel

okLabel?: string

Label for ok button.

Optional pattern

pattern?: string

Pattern used by the browser to validate the input value.

Optional placeholder

placeholder?: string

Placeholder text

Optional prefix

prefix?: string

Additional prefix string preceding the input (e.g. £).

Optional renderer

renderer?: Dialog.IRenderer

An optional renderer for dialog items. Defaults to a shared default renderer.

Optional required

required?: boolean

Whether the input is required (has to be non-empty).

Optional selectionRange

selectionRange?: number

Selection range

Number of characters to pre-select when dialog opens. Default is to select the whole input text if present.

Optional suffix

suffix?: string

Additional suffix string following the input (e.g. $).

Optional text

text?: string

Default input text

title

title: Header

The top level text for the dialog. Defaults to an empty string.

Settings

Member Visibility

Theme

On This Page

cancelLabelcheckboxdefaultButtonhostlabelokLabelpatternplaceholderprefixrendererrequiredselectionRangesuffixtexttitle