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 {@link QuickInput.show}.
There are several reasons why this UI might have to be hidden and the extension will be notified through {@link QuickInput.onDidHide}. (Examples include: an explicit call to {@link 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 {@link QuickInput.hide}.
When the extension no longer needs this input UI, it should {@link QuickInput.dispose} it to allow for freeing up any resources associated with it.
See {@link QuickPick} and {@link InputBox} for concrete UIs.
Fields
show():Void
Makes the input UI visible in its current configuration. Any other input UI will first fire an {@link QuickInput.onDidHide} event.
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 {@link QuickInput.onDidHide}. (Examples include: an explicit call to {@link QuickInput.hide}, the user pressing Esc, some other input UI opening, etc.)
ignoreFocusOut:Bool
If the UI should stay open even when loosing UI focus. Defaults to false. This setting is ignored on iPad and is always false.
enabled:Bool
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.
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.
busy:Bool
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.