Skip to main content

Interface: InputBoxOptions

Options to configure the behavior of the input box UI.

Properties​

ignoreFocusOut?​

optional ignoreFocusOut: boolean

Set to true to keep the input box open when focus moves to another part of the editor or to another window. This setting is ignored on iPad and is always false.

Defined in​

packages/extension-api/src/extension-api.d.ts:1407

markdownDescription?​

optional markdownDescription: string

A description of the field to be show (Markdown format)

Defined in​

packages/extension-api/src/extension-api.d.ts:1391

multiline?​

optional multiline: boolean

Set to true when value represents a multi line content.

Defined in​

packages/extension-api/src/extension-api.d.ts:1412

password?​

optional password: boolean

Controls if a password input is shown. Password input hides the typed text.

Defined in​

packages/extension-api/src/extension-api.d.ts:1401

placeHolder?​

optional placeHolder: string

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

Defined in​

packages/extension-api/src/extension-api.d.ts:1396

prompt?​

optional prompt: string

The text to display underneath the input box.

Defined in​

packages/extension-api/src/extension-api.d.ts:1386

title?​

optional title: string

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

Defined in​

packages/extension-api/src/extension-api.d.ts:1368

value?​

optional value: string

The value to pre-fill in the input box.

Defined in​

packages/extension-api/src/extension-api.d.ts:1373

valueSelection?​

optional valueSelection: [number, number]

Selection of the pre-filled 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 pre-filled value will be selected, when empty (start equals end) only the cursor will be set, otherwise the defined range will be selected.

Defined in​

packages/extension-api/src/extension-api.d.ts:1381

Methods​

validateInput()?​

optional validateInput(value): undefined | null | string | InputBoxValidationMessage | Promise<undefined | null | string | InputBoxValidationMessage>

An optional function that will be called to validate input and to give a hint to the user.

Parameters​

value​

string

The current value of the input box.

Returns​

undefined | null | string | InputBoxValidationMessage | Promise<undefined | null | string | InputBoxValidationMessage>

Either a human-readable string which is presented as an error message or an InputBoxValidationMessage which can provide a specific message severity. Return undefined, null, or the empty string when 'value' is valid.

Defined in​

packages/extension-api/src/extension-api.d.ts:1422