Class MonacoQuickInputImplementation

constructor

• new MonacoQuickInputImplementation(): MonacoQuickInputImplementation

  Returns MonacoQuickInputImplementation

Readonly_serviceBrand

controller

quickAccess

backButton

• get backButton(): IQuickInputButton

  Provides access to the back button in quick input.

  Returns IQuickInputButton

currentQuickInput

• get currentQuickInput(): undefined | IQuickInput

  The current quick pick that is visible. Undefined if none is open.

  Returns undefined | IQuickInput

onHide

• get onHide(): IEvent<void>

  Allows to register on the event that quick input is hiding.

  Returns IEvent<void>

onShow

• get onShow(): IEvent<void>

  Allows to register on the event that quick input is showing.

  Returns IEvent<void>

accept

• accept(keyMods?: IKeyMods): Promise<void>

  Accept the selected item.

  Parameters

  • OptionalkeyMods: IKeyMods

    allows to override the state of key modifiers that should be present when invoking.

  Returns Promise<void>

applyStyles

• applyStyles(styles: IQuickInputStyles): void

  Parameters

  • styles: IQuickInputStyles

  Returns void

back

• back(): Promise<void>

  Navigate back in a multi-step quick input.

  Returns Promise<void>

cancel

• cancel(): Promise<void>

  Cancels quick input and closes it.

  Returns Promise<void>

createInputBox

• createInputBox(): IInputBox

  Provides raw access to the input box controller.

  Returns IInputBox

createQuickPick

• createQuickPick<T extends IQuickPickItem>(
      options: { useSeparators: true },
  ): IQuickPick<T, { useSeparators: true }>

  Provides raw access to the quick pick controller.

  Type Parameters

  • T extends IQuickPickItem

  Parameters

  • options: { useSeparators: true }

  Returns IQuickPick<T, { useSeparators: true }>

• createQuickPick<T extends IQuickPickItem>(
      options: { useSeparators: false },
  ): IQuickPick<T, { useSeparators: false }>

  Type Parameters

  • T extends IQuickPickItem

  Parameters

  • options: { useSeparators: false }

  Returns IQuickPick<T, { useSeparators: false }>

createQuickTree

• createQuickTree<T extends IQuickTreeItem>(): IQuickTree<T>

  Provides raw access to the quick tree controller.

  Type Parameters

  • T extends IQuickTreeItem

    The type of items in the quick tree.

  Returns IQuickTree<T>

createQuickWidget

• createQuickWidget(): IQuickWidget

  Provides raw access to the quick widget controller.

  Returns IQuickWidget

dispose

• dispose(): void

  Returns void

focus

• focus(): void

  Moves focus into quick input.

  Returns void

hide

• hide(): void

  Returns void

input

• input(
      options?: IInputOptions,
      token?: CancellationToken,
  ): Promise<undefined | string>

  Opens the quick input box for text input and returns a promise with the user typed value if any.

  Parameters

  • Optionaloptions: IInputOptions
  • Optionaltoken: CancellationToken

  Returns Promise<undefined | string>

layout

• layout(dimension: IDimension, titleBarOffset: number): void

  Parameters

  • dimension: IDimension
  • titleBarOffset: number

  Returns void

navigate

• navigate(next: boolean, quickNavigate?: IQuickNavigateConfiguration): void

  Navigate inside the opened quick input list.

  Parameters

  • next: boolean
  • OptionalquickNavigate: IQuickNavigateConfiguration

  Returns void

open

• open(filter: string): void

  Parameters

  • filter: string

  Returns void

pick

• pick<T extends IQuickPickItem, O extends IPickOptions<T>>(
      picks: QuickPickInput<T>[] | Promise<QuickPickInput<T>[]>,
      options?: O,
      token?: CancellationToken,
  ): Promise<undefined | (O extends { canPickMany: true } ? T[] : T)>

  Opens the quick input box for selecting items and returns a promise with the user selected item(s) if any.

  Type Parameters

  • T extends IQuickPickItem
  • O extends IPickOptions<T>

  Parameters

  • picks: QuickPickInput<T>[] | Promise<QuickPickInput<T>[]>
  • Optionaloptions: O
  • Optionaltoken: CancellationToken

  Returns Promise<undefined | (O extends { canPickMany: true } ? T[] : T)>

setAlignment

• setAlignment(alignment: "top" | "center" | { left: number; top: number }): void

  Set the alignment of the quick input.

  Parameters

  • alignment: "top" | "center" | { left: number; top: number }

    either a preset or a custom alignment

  Returns void

setContextKey

• setContextKey(key: undefined | string): void

  Parameters

  • key: undefined | string

  Returns void

toggle

• toggle(): void

  Toggle the checked state of the selected item.

  Returns void

toggleHover

• toggleHover(): void

  Toggles hover for the current quick input item

  Returns void