QuickInput class

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.

Implementers

• InputBox
• QuickPick

Available extensions

• QuickInput$Typings

Annotations

• @JS()
• @staticInterop
• @anonymous

Constructors

QuickInput({String? title, num? step, num? totalSteps, bool? enabled, bool? busy, bool? ignoreFocusOut, Event<void>? onDidHide, void show()?, void hide()?, void dispose()?})

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited