dots.vscode.quick-pick — io.github.dots-cljs/dots-vscode 1.89.0-6

Liking cljdoc? Tell your friends :D

ClojureScript only.

dots.vscode.quick-pick

A concrete {@link QuickInput } to let the user pick an item from a list of items of type T. The items can be filtered through a filter text field and there is an option {@link QuickPick.canSelectMany canSelectMany} to allow for selecting multiple items.

Note that in many cases the more convenient {@link window.showQuickPick } is easier to use. {@link window.createQuickPick } should be used when {@link window.showQuickPick } does not offer the required flexibility.

A concrete {@link QuickInput } to let the user pick an item from a
list of items of type T. The items can be filtered through a filter text field and
there is an option {@link QuickPick.canSelectMany canSelectMany} to allow for
selecting multiple items.

Note that in many cases the more convenient {@link window.showQuickPick }
is easier to use. {@link window.createQuickPick } should be used
when {@link window.showQuickPick } does not offer the required flexibility.

active-items^cljs

(active-items quick-pick)

Active items. This can be read and updated by the extension.

Returns: readonly T[]

Active items. This can be read and updated by the extension.

**Returns:** `readonly T[]`

source raw docstring

busy?^cljs

(busy? quick-pick)

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`

source raw docstring

buttons^cljs

(buttons quick-pick)

Buttons for actions in the UI.

Returns: readonly QuickInputButton[]

Buttons for actions in the UI.

**Returns:** `readonly QuickInputButton[]`

source raw docstring

can-select-many?^cljs

(can-select-many? quick-pick)

If multiple items can be selected at the same time. Defaults to false.

Returns: boolean

If multiple items can be selected at the same time. Defaults to false.

**Returns:** `boolean`

source raw docstring

dispose^cljs

(dispose quick-pick)

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`

source raw docstring

enabled?^cljs

(enabled? quick-pick)

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`

source raw docstring

hide^cljs

(hide quick-pick)

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`

source raw docstring

ignore-focus-out?^cljs

(ignore-focus-out? quick-pick)

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`

source raw docstring

items^cljs

(items quick-pick)

Items to pick from. This can be read and updated by the extension.

Returns: readonly T[]

Items to pick from. This can be read and updated by the extension.

**Returns:** `readonly T[]`

source raw docstring

keep-scroll-position?^cljs

(keep-scroll-position? quick-pick)

An optional flag to maintain the scroll position of the quick pick when the quick pick items are updated. Defaults to false.

Returns: boolean | undefined

An optional flag to maintain the scroll position of the quick pick when the quick pick items are updated. Defaults to false.

**Returns:** `boolean | undefined`

source raw docstring

match-on-description?^cljs

(match-on-description? quick-pick)

If the filter text should also be matched against the description of the items. Defaults to false.

Returns: boolean

If the filter text should also be matched against the description of the items. Defaults to false.

**Returns:** `boolean`

source raw docstring

match-on-detail?^cljs

(match-on-detail? quick-pick)

If the filter text should also be matched against the detail of the items. Defaults to false.

Returns: boolean

If the filter text should also be matched against the detail of the items. Defaults to false.

**Returns:** `boolean`

source raw docstring

on-did-accept^cljs

(on-did-accept quick-pick)

(on-did-accept quick-pick listener)

(on-did-accept quick-pick listener this-args)

(on-did-accept quick-pick listener this-args disposables)

An event signaling when the user indicated acceptance of the selected item(s).

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.

An event signaling when the user indicated acceptance of the selected item(s).

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

source raw docstring

on-did-change-active^cljs

(on-did-change-active quick-pick)

(on-did-change-active quick-pick listener)

(on-did-change-active quick-pick listener this-args)

(on-did-change-active quick-pick listener this-args disposables)

An event signaling when the active items have changed.

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.

An event signaling when the active items have changed.

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

source raw docstring

on-did-change-selection^cljs

(on-did-change-selection quick-pick)

(on-did-change-selection quick-pick listener)

(on-did-change-selection quick-pick listener this-args)

(on-did-change-selection quick-pick listener this-args disposables)

An event signaling when the selected items have changed.

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.

An event signaling when the selected items have changed.

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

source raw docstring

on-did-change-value^cljs

(on-did-change-value quick-pick)

(on-did-change-value quick-pick listener)

(on-did-change-value quick-pick listener this-args)

(on-did-change-value quick-pick listener this-args disposables)

An event signaling when the value of the filter text has changed.

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.

An event signaling when the value of the filter text has changed.

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

source raw docstring

on-did-hide^cljs

(on-did-hide quick-pick)

(on-did-hide quick-pick listener)

(on-did-hide quick-pick listener this-args)

(on-did-hide quick-pick 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 - 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.

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.

source raw docstring

on-did-trigger-button^cljs

(on-did-trigger-button quick-pick)

(on-did-trigger-button quick-pick listener)

(on-did-trigger-button quick-pick listener this-args)

(on-did-trigger-button quick-pick listener this-args disposables)

An event signaling when a button in the title bar was triggered. This event does not fire for buttons on a {@link QuickPickItem }.

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.

An event signaling when a button in the title bar was triggered.
This event does not fire for buttons on a {@link QuickPickItem }.

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

source raw docstring

on-did-trigger-item-button^cljs

(on-did-trigger-item-button quick-pick)

(on-did-trigger-item-button quick-pick listener)

(on-did-trigger-item-button quick-pick listener this-args)

(on-did-trigger-item-button quick-pick listener this-args disposables)

An event signaling when a button in a particular {@link QuickPickItem } was triggered. This event does not fire for buttons in the title bar.

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.

An event signaling when a button in a particular {@link QuickPickItem } was triggered.
This event does not fire for buttons in the title bar.

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

source raw docstring

placeholder^cljs

(placeholder quick-pick)

Optional placeholder shown in the filter textbox when no filter has been entered.

Returns: string | undefined

Optional placeholder shown in the filter textbox when no filter has been entered.

**Returns:** `string | undefined`

source raw docstring

selected-items^cljs

(selected-items quick-pick)

Selected items. This can be read and updated by the extension.

Returns: readonly T[]

Selected items. This can be read and updated by the extension.

**Returns:** `readonly T[]`

source raw docstring

set-active-items!^cljs

(set-active-items! quick-pick value)

Active items. This can be read and updated by the extension.

Active items. This can be read and updated by the extension.

source raw docstring

set-busy!^cljs

(set-busy! quick-pick 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.

source raw docstring

set-buttons!^cljs

(set-buttons! quick-pick value)

Buttons for actions in the UI.

Buttons for actions in the UI.

source raw docstring

set-can-select-many!^cljs

(set-can-select-many! quick-pick value)

If multiple items can be selected at the same time. Defaults to false.

If multiple items can be selected at the same time. Defaults to false.

source raw docstring

set-enabled!^cljs

(set-enabled! quick-pick 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.

source raw docstring

set-ignore-focus-out!^cljs

(set-ignore-focus-out! quick-pick 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.

source raw docstring

set-items!^cljs

(set-items! quick-pick value)

Items to pick from. This can be read and updated by the extension.

Items to pick from. This can be read and updated by the extension.

source raw docstring

set-keep-scroll-position!^cljs

(set-keep-scroll-position! quick-pick value)

An optional flag to maintain the scroll position of the quick pick when the quick pick items are updated. Defaults to false.

An optional flag to maintain the scroll position of the quick pick when the quick pick items are updated. Defaults to false.

source raw docstring

set-match-on-description!^cljs

(set-match-on-description! quick-pick value)

If the filter text should also be matched against the description of the items. Defaults to false.

If the filter text should also be matched against the description of the items. Defaults to false.

source raw docstring

set-match-on-detail!^cljs

(set-match-on-detail! quick-pick value)

If the filter text should also be matched against the detail of the items. Defaults to false.

If the filter text should also be matched against the detail of the items. Defaults to false.

source raw docstring

set-on-did-hide!^cljs

(set-on-did-hide! quick-pick 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.)

source raw docstring

set-placeholder!^cljs

(set-placeholder! quick-pick value)

Optional placeholder shown in the filter textbox when no filter has been entered.

Optional placeholder shown in the filter textbox when no filter has been entered.

source raw docstring

set-selected-items!^cljs

(set-selected-items! quick-pick value)

Selected items. This can be read and updated by the extension.

Selected items. This can be read and updated by the extension.

source raw docstring

set-step!^cljs

(set-step! quick-pick value)

An optional current step count.

An optional current step count.

source raw docstring

set-title!^cljs

(set-title! quick-pick value)

An optional title.

An optional title.

source raw docstring

set-total-steps!^cljs

(set-total-steps! quick-pick value)

An optional total step count.

An optional total step count.

source raw docstring

set-value!^cljs

(set-value! quick-pick value)

Current value of the filter text.

Current value of the filter text.

source raw docstring

show^cljs

(show quick-pick)

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`

source raw docstring

step^cljs

(step quick-pick)

An optional current step count.

Returns: number | undefined

An optional current step count.

**Returns:** `number | undefined`

source raw docstring

title^cljs

(title quick-pick)

An optional title.

Returns: string | undefined

An optional title.

**Returns:** `string | undefined`

source raw docstring

total-steps^cljs

(total-steps quick-pick)

An optional total step count.

Returns: number | undefined

An optional total step count.

**Returns:** `number | undefined`

source raw docstring

value^cljs

(value quick-pick)

Current value of the filter text.

Returns: string

Current value of the filter text.

**Returns:** `string`

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub