Options
All
  • Public
  • Public/Protected
  • All
Menu

A concrete QuickInput to let the user input a text value.

Note that in many cases the more convenient window.showInputBox is easier to use. window.createInputBox should be used when window.showInputBox does not offer the required flexibility.

层级

索引

Properties(16)

title

title: undefined | string

An optional title.

step

step: undefined | number

An optional current step count.

totalSteps

totalSteps: undefined | number

An optional total step count.

enabled

enabled: boolean

If the UI should allow for user input. Defaults to true.

Change this to false, e.g., while validating user input or loading data for the next step in user input.

busy

busy: boolean

If the UI should show a progress indicator. Defaults to false.

Change this to true, e.g., while loading more data or validating user input.

ignoreFocusOut

ignoreFocusOut: boolean

If the UI should stay open even when loosing UI focus. Defaults to false. This setting is ignored on iPad and is always false.

onDidHide

onDidHide: Event<void>

An event signaling when this input UI is hidden.

There are several reasons why this UI might have to be hidden and the extension will be notified through QuickInput.onDidHide. (Examples include: an explicit call to QuickInput.hide, the user pressing Esc, some other input UI opening, etc.)

value

value: string

Current input value.

placeholder

placeholder: undefined | string

Optional placeholder in the filter text.

password

password: boolean

If the input value should be hidden. Defaults to false.

Readonly onDidChangeValue

onDidChangeValue: Event<string>

An event signaling when the value has changed.

Readonly onDidAccept

onDidAccept: Event<void>

An event signaling when the user indicated acceptance of the input value.

buttons

buttons: readonly QuickInputButton[]

Buttons for actions in the UI.

Readonly onDidTriggerButton

onDidTriggerButton: Event<QuickInputButton>

An event signaling when a button was triggered.

prompt

prompt: undefined | string

An optional prompt text providing some ask or explanation to the user.

validationMessage

validationMessage: undefined | string

An optional validation message indicating a problem with the current input value.

Methods(3)

show

  • show(): void

hide

  • hide(): void

dispose

  • dispose(): void
  • Dispose of this input UI and any associated resources. If it is still visible, it is first hidden. After this call the input UI is no longer functional and no additional methods or properties on it should be accessed. Instead a new input UI should be created.

    Returns void

友链:VS Code 中文文档 | VS Code 官网文档 | VS Code 扩展市场

Generated by TypeDoc. Maintained by 洛竹