Interface QuickInput

A light-weight user input UI that is initially not visible. After configuring it through its properties the extension can make it visible by calling QuickInput.show.

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.)

A user pressing Enter or some other gesture implying acceptance of the current state does not automatically hide this UI component. It is up to the extension to decide whether to accept the user's input and if the UI should indeed be hidden through a call to QuickInput.hide.

When the extension no longer needs this input UI, it should QuickInput.dispose it to allow for freeing up any resources associated with it.

See QuickPick and InputBox for concrete UIs.

interface QuickInput {
    busy: boolean;
    enabled: boolean;
    ignoreFocusOut: boolean;
    onDidHide: Event<void>;
    step: undefined | number;
    title: undefined | string;
    totalSteps: undefined | number;
    dispose(): void;
    hide(): void;
    show(): void;
}

Hierarchy (view full)

Implemented by

Properties

busy enabled ignoreFocusOut onDidHide step title totalSteps

Methods

dispose hide show

Properties

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.

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.

ignoreFocusOut

ignoreFocusOut: boolean

If the UI should stay open even when loosing UI focus. Defaults to 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.)

step

step: undefined | number

An optional current step count.

title

title: undefined | string

An optional title.

totalSteps

totalSteps: undefined | number

An optional total step count.

Methods

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

hide

show

Settings

Member Visibility

Theme

On This Page

busyenabledignoreFocusOutonDidHidesteptitletotalStepsdisposehideshow