dots.vscode.quick-input
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.
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.busy?cljs
(busy? quick-input)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.
Returns: 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. **Returns:** `boolean`
disposecljs
(dispose quick-input)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
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`
enabled?cljs
(enabled? quick-input)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.
Returns: 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. **Returns:** `boolean`
hidecljs
(hide quick-input)Hides this input UI. This will also fire an {@link QuickInput.onDidHide } event.
Returns: void
Hides this input UI. This will also fire an {@link QuickInput.onDidHide }
event.
**Returns:** `void`ignore-focus-out?cljs
(ignore-focus-out? quick-input)If the UI should stay open even when loosing UI focus. Defaults to false. This setting is ignored on iPad and is always false.
Returns: 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. **Returns:** `boolean`
on-did-hidecljs
(on-did-hide quick-input)(on-did-hide quick-input listener)(on-did-hide quick-input listener this-args)(on-did-hide quick-input listener this-args disposables)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.)
Parameters:
listener:(e: T) => any- The listener function will be called when the event happens.this-args:any- Thethis-argument which will be used when calling the event listener.disposables:Disposable[] | undefined- An array to which a {@link Disposable } will be added.
Returns: Disposable - A disposable which unsubscribes the event listener.
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.)
**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.
**Returns:** `Disposable` - A disposable which unsubscribes the event listener.set-busy!cljs
(set-busy! quick-input value)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.
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.
set-enabled!cljs
(set-enabled! quick-input value)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.
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.
set-ignore-focus-out!cljs
(set-ignore-focus-out! quick-input value)If the UI should stay open even when loosing UI focus. Defaults to false. This setting is ignored on iPad and is always false.
If the UI should stay open even when loosing UI focus. Defaults to false. This setting is ignored on iPad and is always false.
set-on-did-hide!cljs
(set-on-did-hide! quick-input value)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.)
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.)set-step!cljs
(set-step! quick-input value)An optional current step count.
An optional current step count.
set-title!cljs
(set-title! quick-input value)An optional title.
An optional title.
set-total-steps!cljs
(set-total-steps! quick-input value)An optional total step count.
An optional total step count.
showcljs
(show quick-input)Makes the input UI visible in its current configuration. Any other input UI will first fire an {@link QuickInput.onDidHide } event.
Returns: void
Makes the input UI visible in its current configuration. Any other input
UI will first fire an {@link QuickInput.onDidHide } event.
**Returns:** `void`stepcljs
(step quick-input)An optional current step count.
Returns: number | undefined
An optional current step count. **Returns:** `number | undefined`
titlecljs
(title quick-input)An optional title.
Returns: string | undefined
An optional title. **Returns:** `string | undefined`
total-stepscljs
(total-steps quick-input)An optional total step count.
Returns: number | undefined
An optional total step count. **Returns:** `number | undefined`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close