Class MonacoQuickInputService

Implements

QuickInputService

Index

Constructors

constructor

new MonacoQuickInputService(): MonacoQuickInputService
Returns MonacoQuickInputService

Properties

`Protected` `Readonly`keybindingRegistry

keybindingRegistry: KeybindingRegistry

Accessors

backButton

get backButton(): QuickInputButton
Returns QuickInputButton
Implementation of QuickInputService.backButton
- Defined in packages/monaco/src/browser/monaco-quick-input-service.ts:336

onHide

get onHide(): Event<void>
Returns Event<void>
Implementation of QuickInputService.onHide
- Defined in packages/monaco/src/browser/monaco-quick-input-service.ts:342

onShow

get onShow(): Event<void>
Returns Event<void>
Implementation of QuickInputService.onShow
- Defined in packages/monaco/src/browser/monaco-quick-input-service.ts:341

Methods

`Protected`convertItems

convertItems<T extends QuickPickItem>(item: T): MonacoQuickPickItem<T>
Type Parameters
- T extends QuickPickItem
Parameters
- item: T
Returns MonacoQuickPickItem<T>
- Defined in packages/monaco/src/browser/monaco-quick-input-service.ts:461

createInputBox

createInputBox(): InputBox
Returns InputBox
Implementation of QuickInputService.createInputBox
- Defined in packages/monaco/src/browser/monaco-quick-input-service.ts:348

createQuickPick

createQuickPick<T extends QuickPickItem>(): QuickPick<T>
Provides raw access to the quick pick controller.
Type Parameters
- T extends QuickPickItem
Returns QuickPick<T>
Implementation of QuickInputService.createQuickPick
- Defined in packages/monaco/src/browser/monaco-quick-input-service.ts:452

hide

hide(): void
Returns void
Implementation of QuickInputService.hide
- Defined in packages/monaco/src/browser/monaco-quick-input-service.ts:465

input

input(
options?: InputOptions,
token?: CancellationToken,
): Promise<undefined | string>
Parameters
- Optionaloptions: InputOptions
- Optionaltoken: CancellationToken
Returns Promise<undefined | string>
Implementation of QuickInputService.input
- Defined in packages/monaco/src/browser/monaco-quick-input-service.ts:353

open

open(filter: string): void
Parameters
- filter: string
Returns void
Implementation of QuickInputService.open
- Defined in packages/monaco/src/browser/monaco-quick-input-service.ts:344

pick

pick<T extends QuickPickItem, O extends PickOptions<T> = PickOptions<T>>(
    picks: QuickPickInput<T>[] | Promise<QuickPickInput<T>[]>,
    options?: O,
    token?: CancellationToken,
): Promise<undefined | T | T[]>
Type Parameters
- T extends QuickPickItem
- O extends PickOptions<T> = PickOptions<T>
Parameters
- picks: QuickPickInput<T>[] | Promise<QuickPickInput<T>[]>
- Optionaloptions: O
- Optionaltoken: CancellationToken
Returns Promise<undefined | T | T[]>
Implementation of QuickInputService.pick
- Defined in packages/monaco/src/browser/monaco-quick-input-service.ts:365

showQuickPick

showQuickPick<T extends QuickPickItem>(
items: (T | QuickPickSeparator)[],
options?: QuickPickOptions<T>,
): Promise<undefined | T>
Type Parameters
- T extends QuickPickItem
Parameters
- items: (T | QuickPickSeparator)[]
- Optionaloptions: QuickPickOptions<T>
Returns Promise<undefined | T>
Implementation of QuickInputService.showQuickPick
- Defined in packages/monaco/src/browser/monaco-quick-input-service.ts:371

wrapQuickPick

wrapQuickPick<T extends QuickPickItem>(
wrapped: IQuickPick<MonacoQuickPickItem<T>, { useSeparators: true }>,
): QuickPick<T>
Type Parameters
- T extends QuickPickItem
Parameters
- wrapped: IQuickPick<MonacoQuickPickItem<T>, { useSeparators: true }>
Returns QuickPick<T>
- Defined in packages/monaco/src/browser/monaco-quick-input-service.ts:457

Class MonacoQuickInputService

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MonacoQuickInputService

Properties

Protected ReadonlykeybindingRegistry

Accessors

backButton

Returns QuickInputButton

onHide

Returns Event<void>

onShow

Returns Event<void>

Methods

ProtectedconvertItems

Type Parameters

Parameters

Returns MonacoQuickPickItem<T>

createInputBox

Returns InputBox

createQuickPick

Type Parameters

Returns QuickPick<T>

hide

Returns void

input

Parameters

Returns Promise<undefined | string>

open

Parameters

Returns void

pick

Type Parameters

Parameters

Returns Promise<undefined | T | T[]>

showQuickPick

Type Parameters

Parameters

Returns Promise<undefined | T>

wrapQuickPick

Type Parameters

Parameters

Returns QuickPick<T>

Settings

On This Page

`Protected` `Readonly`keybindingRegistry

`Protected`convertItems