Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QuickInputOptions

Hierarchy

  • QuickInputOptions

Index

Properties

Optional busy

busy: undefined | false | true

Show the progress indicator if true

Optional buttons

buttons: ReadonlyArray<QuickTitleButton>

Buttons that are displayed on the title panel

Optional enabled

enabled: undefined | false | true

Allow user input

Optional ignoreFocusOut

ignoreFocusOut: undefined | false | true

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: undefined | false | true

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

Optional placeHolder

placeHolder: undefined | string

The place holder in the input box to guide the user what to type.

Optional prompt

prompt: undefined | string

The text to display under the input box.

Optional step

step: number | undefined

Current step count

Optional title

title: string | undefined

The title of the input

Optional totalSteps

totalSteps: number | undefined

Total number of steps

Optional validationMessage

validationMessage: string | undefined

Text for when there is a problem with the current input value

Optional value

value: undefined | string

The prefill value.

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 validateInput

  • validateInput(value: string): MaybePromise<string | undefined>