Class QuickPickExt<T>

Base implementation of QuickPick that uses QuickOpenExt. Missing functionality is going to be implemented in the scope of https://github.com/eclipse-theia/theia/issues/5059

Constructors

constructor

new QuickPickExt<T extends QuickPickItem>(
    quickOpen: QuickOpenExtImpl,
    quickOpenMain: QuickOpenMain,
    plugin: Plugin,
    onDispose: () => void,
): QuickPickExt<T>
Type Parameters
- T extends QuickPickItem
Parameters
- quickOpen: QuickOpenExtImpl
- quickOpenMain: QuickOpenMain
- plugin: Plugin
- onDispose: () => void
Returns QuickPickExt<T>
Overrides QuickInputExt.constructor
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:584

Properties

_id

_id: number = ...

`Protected`disposableCollection

disposableCollection: DisposableCollection

`Protected`expectingHide

expectingHide: boolean = false

onDidChangeActive

onDidChangeActive: Event<T[]> = ...

An event signaling when the active items have changed.

onDidChangeSelection

onDidChangeSelection: Event<T[]> = ...

An event signaling when the selected items have changed.

onDidTriggerItemButton

onDidTriggerItemButton: Event<QuickPickItemButtonEvent<T>> = ...

An event signaling when a button in a particular QuickPickItem was triggered.

This event does not fire for buttons in the title bar which are part of buttons.

`Readonly`plugin

plugin: Plugin

`Readonly`quickOpen

quickOpen: QuickOpenExtImpl

`Readonly`quickOpenMain

quickOpenMain: QuickOpenMain

`Protected`visible

visible: boolean

Accessors

activeItems

get activeItems(): T[]
Active items. This can be read and updated by the extension.

Returns T[]
Implementation of QuickPick.activeItems
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:687
set activeItems(activeItems: T[]): void
Active items. This can be read and updated by the extension.
Parameters
- activeItems: T[]
Returns void
Implementation of QuickPick.activeItems
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:691

busy

get busy(): boolean
Determines if the UI should show a progress indicator. Defaults to false.

Change this to true, for example, while loading more data or validating user input.

Returns boolean
Implementation of QuickPick.busy
Inherited from QuickInputExt.busy
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:333
set busy(busy: boolean): void
Determines if the UI should show a progress indicator. Defaults to false.

Change this to true, for example, while loading more data or validating user input.
Parameters
- busy: boolean
Returns void
Implementation of QuickPick.busy
Inherited from QuickInputExt.busy
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:337

buttons

get buttons(): QuickInputButton[]
Buttons for actions in the UI.

Returns QuickInputButton[]
Implementation of QuickPick.buttons
Inherited from QuickInputExt.buttons
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:378
set buttons(buttons: QuickInputButton[]): void
Buttons for actions in the UI.
Parameters
- buttons: QuickInputButton[]
Returns void
Implementation of QuickPick.buttons
Inherited from QuickInputExt.buttons
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:382

canSelectMany

get canSelectMany(): boolean
Determines if multiple items can be selected at the same time. Defaults to false.

Returns boolean
Implementation of QuickPick.canSelectMany
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:642
set canSelectMany(canSelectMany: boolean): void
Determines if multiple items can be selected at the same time. Defaults to false.
Parameters
- canSelectMany: boolean
Returns void
Implementation of QuickPick.canSelectMany
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:646

enabled

get enabled(): boolean
Determines if the UI should allow for user input. Defaults to true.

Change this to false, for example, while validating user input or loading data for the next step in user input.

Returns boolean
Implementation of QuickPick.enabled
Inherited from QuickInputExt.enabled
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:324
set enabled(enabled: boolean): void
Determines if the UI should allow for user input. Defaults to true.

Change this to false, for example, while validating user input or loading data for the next step in user input.
Parameters
- enabled: boolean
Returns void
Implementation of QuickPick.enabled
Inherited from QuickInputExt.enabled
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:328

ignoreFocusOut

get ignoreFocusOut(): boolean
Determines if the UI should stay open even when losing UI focus. Defaults to false. This setting is ignored on iPad and is always false.

Returns boolean
Implementation of QuickPick.ignoreFocusOut
Inherited from QuickInputExt.ignoreFocusOut
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:342
set ignoreFocusOut(ignoreFocusOut: boolean): void
Determines if the UI should stay open even when losing UI focus. Defaults to false. This setting is ignored on iPad and is always false.
Parameters
- ignoreFocusOut: boolean
Returns void
Implementation of QuickPick.ignoreFocusOut
Inherited from QuickInputExt.ignoreFocusOut
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:346

items

get items(): T[]
Items to pick from. This can be read and updated by the extension.

Returns T[]
Implementation of QuickPick.items
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:600
set items(items: T[]): void
Items to pick from. This can be read and updated by the extension.
Parameters
- items: T[]
Returns void
Implementation of QuickPick.items
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:604

keepScrollPosition

get keepScrollPosition(): boolean
Determines if the scroll position is maintained when the quick pick items are updated. Defaults to false.

Returns boolean
Implementation of QuickPick.keepScrollPosition
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:678
set keepScrollPosition(keepScrollPosition: boolean): void
Determines if the scroll position is maintained when the quick pick items are updated. Defaults to false.
Parameters
- keepScrollPosition: boolean
Returns void
Implementation of QuickPick.keepScrollPosition
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:682

matchOnDescription

get matchOnDescription(): boolean
Determines if the filter text should also be matched against the description of the items. Defaults to false.

Returns boolean
Implementation of QuickPick.matchOnDescription
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:651
set matchOnDescription(matchOnDescription: boolean): void
Determines if the filter text should also be matched against the description of the items. Defaults to false.
Parameters
- matchOnDescription: boolean
Returns void
Implementation of QuickPick.matchOnDescription
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:655

matchOnDetail

get matchOnDetail(): boolean
Determines if the filter text should also be matched against the detail of the items. Defaults to false.

Returns boolean
Implementation of QuickPick.matchOnDetail
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:660
set matchOnDetail(matchOnDetail: boolean): void
Determines if the filter text should also be matched against the detail of the items. Defaults to false.
Parameters
- matchOnDetail: boolean
Returns void
Implementation of QuickPick.matchOnDetail
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:664

onDidAccept

get onDidAccept(): Event<void>
An event signaling when the user indicated acceptance of the selected item(s).

Returns Event<void>
Implementation of QuickPick.onDidAccept
Inherited from QuickInputExt.onDidAccept
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:499

onDidChangeValue

get onDidChangeValue(): Event<string>
An event signaling when the value of the filter text has changed.

Returns Event<string>
Implementation of QuickPick.onDidChangeValue
Inherited from QuickInputExt.onDidChangeValue
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:503

onDidHide

get 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 onDidHide. Examples include: an explicit call to hide, the user pressing Esc, some other input UI opening, etc.

Returns Event<void>
Implementation of QuickPick.onDidHide
Inherited from QuickInputExt.onDidHide
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:495

onDidTriggerButton

get onDidTriggerButton(): Event<QuickInputButton>
An event signaling when a button was triggered.

This event fires for buttons stored in the buttons array. This event does not fire for buttons on a QuickPickItem.

Returns Event<QuickInputButton>
Implementation of QuickPick.onDidTriggerButton
Inherited from QuickInputExt.onDidTriggerButton
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:507

placeholder

get placeholder(): undefined | string
Optional placeholder text displayed in the filter text box when no value has been entered.

Returns undefined | string
Implementation of QuickPick.placeholder
Inherited from QuickInputExt.placeholder
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:360
set placeholder(placeholder: undefined | string): void
Optional placeholder text displayed in the filter text box when no value has been entered.
Parameters
- placeholder: undefined | string
Returns void
Implementation of QuickPick.placeholder
Inherited from QuickInputExt.placeholder
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:364

prompt

get prompt(): undefined | string
Optional text that provides instructions or context to the user.

The prompt is displayed below the input box and above the list of items.

Returns undefined | string
Implementation of QuickPick.prompt
Inherited from QuickInputExt.prompt
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:369
set prompt(prompt: undefined | string): void
Optional text that provides instructions or context to the user.

The prompt is displayed below the input box and above the list of items.
Parameters
- prompt: undefined | string
Returns void
Implementation of QuickPick.prompt
Inherited from QuickInputExt.prompt
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:373

selectedItems

get selectedItems(): T[]
Selected items. This can be read and updated by the extension.

Returns T[]
Implementation of QuickPick.selectedItems
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:698
set selectedItems(selectedItems: T[]): void
Selected items. This can be read and updated by the extension.
Parameters
- selectedItems: T[]
Returns void
Implementation of QuickPick.selectedItems
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:702

sortByLabel

get sortByLabel(): boolean
Returns boolean
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:669
set sortByLabel(sortByLabel: boolean): void
Parameters
- sortByLabel: boolean
Returns void
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:673

step

get step(): undefined | number
An optional current step count for multi-step input flows.

Returns undefined | number
Implementation of QuickPick.step
Inherited from QuickInputExt.step
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:306
set step(step: undefined | number): void
An optional current step count for multi-step input flows.
Parameters
- step: undefined | number
Returns void
Implementation of QuickPick.step
Inherited from QuickInputExt.step
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:310

title

get title(): undefined | string
An optional title for the input UI.

Returns undefined | string
Implementation of QuickPick.title
Inherited from QuickInputExt.title
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:297
set title(title: undefined | string): void
An optional title for the input UI.
Parameters
- title: undefined | string
Returns void
Implementation of QuickPick.title
Inherited from QuickInputExt.title
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:301

totalSteps

get totalSteps(): undefined | number
An optional total step count for multi-step input flows.

Returns undefined | number
Implementation of QuickPick.totalSteps
Inherited from QuickInputExt.totalSteps
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:315
set totalSteps(totalSteps: undefined | number): void
An optional total step count for multi-step input flows.
Parameters
- totalSteps: undefined | number
Returns void
Implementation of QuickPick.totalSteps
Inherited from QuickInputExt.totalSteps
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:319

value

get value(): string
The current value of the filter text.

Returns string
Implementation of QuickPick.value
Inherited from QuickInputExt.value
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:351
set value(value: string): void
The current value of the filter text.
Parameters
- value: string
Returns void
Implementation of QuickPick.value
Inherited from QuickInputExt.value
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:355

Methods

_fireAccept

_fireAccept(): void
Returns void
Inherited from QuickInputExt._fireAccept
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:475

_fireButtonTrigger

_fireButtonTrigger(btn: QuickInputButton): void
Parameters
- btn: QuickInputButton
Returns void
Inherited from QuickInputExt._fireButtonTrigger
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:491

_fireChangedValue

_fireChangedValue(changedValue: string): void
Parameters
- changedValue: string
Returns void
Inherited from QuickInputExt._fireChangedValue
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:479

_fireDidChangeActive

_fireDidChangeActive(handles: number[]): void
Parameters
- handles: number[]
Returns void
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:709

_fireDidChangeSelection

_fireDidChangeSelection(handles: number[]): void
Parameters
- handles: number[]
Returns void
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:715

_fireDidTriggerItemButton

_fireDidTriggerItemButton(itemHandle: number, buttonHandle: number): void
Parameters
- itemHandle: number
- buttonHandle: number
Returns void
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:723

_fireHide

_fireHide(): void
Returns void
Inherited from QuickInputExt._fireHide
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:484

`Protected`convertURL

convertURL(
iconPath: URI | { dark: string | URI; light: string | URI } | ThemeIcon,
): URI | ThemeIcon | { dark: string | URI; light: string | URI }
Parameters
- iconPath: URI | { dark: string | URI; light: string | URI } | ThemeIcon
Returns URI | ThemeIcon | { dark: string | URI; light: string | URI }
Inherited from QuickInputExt.convertURL
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:449

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
Implementation of QuickPick.dispose
Inherited from QuickInputExt.dispose
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:404

hide

hide(): void
Hides this input UI.

This will also fire an onDidHide event.

Returns void
Implementation of QuickPick.hide
Inherited from QuickInputExt.hide
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:445

show

show(): void
Makes the input UI visible in its current configuration.

Any other input UI will first fire an onDidHide event.

Returns void
Implementation of QuickPick.show
Inherited from QuickInputExt.show
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:398

`Protected`update

update(properties: Record<string, any>): void
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- properties: Record<string, any>
Returns void
Inherited from QuickInputExt.update
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:416

Class QuickPickExt<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns QuickPickExt<T>

Properties

_id

ProtecteddisposableCollection

ProtectedexpectingHide

onDidChangeActive

onDidChangeSelection

onDidTriggerItemButton

Readonlyplugin

ReadonlyquickOpen

ReadonlyquickOpenMain

Protectedvisible

Accessors

activeItems

Returns T[]

Parameters

Returns void

busy

Returns boolean

Parameters

Returns void

buttons

Returns QuickInputButton[]

Parameters

Returns void

canSelectMany

Returns boolean

Parameters

Returns void

enabled

Returns boolean

Parameters

Returns void

ignoreFocusOut

Returns boolean

Parameters

Returns void

items

Returns T[]

Parameters

Returns void

keepScrollPosition

Returns boolean

Parameters

Returns void

matchOnDescription

Returns boolean

Parameters

Returns void

matchOnDetail

Returns boolean

Parameters

Returns void

onDidAccept

Returns Event<void>

onDidChangeValue

Returns Event<string>

onDidHide

Returns Event<void>

onDidTriggerButton

Returns Event<QuickInputButton>

placeholder

Returns undefined | string

Parameters

Returns void

prompt

Returns undefined | string

`Protected`disposableCollection

`Protected`expectingHide

`Readonly`plugin

`Readonly`quickOpen

`Readonly`quickOpenMain

`Protected`visible

`Protected`convertURL

`Protected`update