Interface InputBoxOptions

Options to configure the behavior of the input box UI.

interface InputBoxOptions {
    ignoreFocusOut?: boolean;
    password?: boolean;
    placeHolder?: string;
    prompt?: string;
    title?: string;
    value?: string;
    valueSelection?: [number, number];
    onAccept?(): void;
    validateInput?(value): undefined | null | string | InputBoxValidationMessage | Thenable<undefined | null | string | InputBoxValidationMessage>;
}

Properties

ignoreFocusOut? password? placeHolder? prompt? title? value? valueSelection?

Methods

onAccept? validateInput?

Properties

Optional ignoreFocusOut

ignoreFocusOut?: boolean

Set to true to keep the input box open when focus moves to another part of the editor or to another window.

Optional password

password?: boolean

Set to true to show a password prompt that will not show the typed value.

Optional placeHolder

placeHolder?: string

An optional string to show as place holder in the input box to guide the user what to type.

Optional prompt

prompt?: string

The text to display underneath the input box.

Optional title

title?: string

An optional string that represents the title of the input box.

Optional value

value?: string

The value to prefill in the input box.

Optional valueSelection

valueSelection?: [number, number]

Selection of the prefilled value. Defined as tuple of two number where the first is the inclusive start index and the second the exclusive end index. When undefined the whole word will be selected, when empty (start equals end) only the cursor will be set, otherwise the defined range will be selected.

Methods

Optional onAccept

Optional validateInput

Settings

Member Visibility

Theme

On This Page

ignoreFocusOutpasswordplaceHolderprompttitlevaluevalueSelectiononAcceptvalidateInput