Interface IItemOptions

Constructor options for item selection input dialogs

interface IItemOptions {
    cancelLabel?: string;
    checkbox?: null | Partial<ICheckbox>;
    current?: string | number;
    defaultButton?: number;
    editable?: boolean;
    host?: HTMLElement;
    items: string[];
    label?: string;
    okLabel?: string;
    placeholder?: string;
    prefix?: string;
    renderer?: Dialog.IRenderer;
    suffix?: string;
    title: Header;
}

Hierarchy (View Summary)

Properties

cancelLabel? checkbox? current? defaultButton? editable? host? items label? okLabel? placeholder? prefix? renderer? suffix? title

Properties

OptionalcancelLabel

cancelLabel?: string

Label for cancel button.

Optionalcheckbox

checkbox?: null | Partial<ICheckbox>

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

Optionalcurrent

current?: string | number

Default choice

If the list is editable a string with a default value can be provided otherwise the index of the default choice should be given.

OptionaldefaultButton

defaultButton?: number

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

Optionaleditable

editable?: boolean

Is the item editable?

Optionalhost

host?: HTMLElement

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

items

items: string[]

List of choices

Optionallabel

label?: string

Label of the requested input

OptionalokLabel

okLabel?: string

Label for ok button.

Optionalplaceholder

placeholder?: string

Placeholder text for editable input

Optionalprefix

prefix?: string

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

Optionalrenderer

renderer?: Dialog.IRenderer

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

Optionalsuffix

suffix?: string

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

title

title: Header

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

Settings

Member Visibility

On This Page

Properties