Theia API Documentation v1.65.0
    Preparing search index...

    Implements

    • IQuickInputService
    Index

    Constructors

    Properties

    _serviceBrand: undefined
    colorRegistry: MonacoColorRegistry
    container: HTMLElement
    controller: QuickInputController
    inQuickOpen: IContextKey<boolean>
    quickAccess: IQuickAccessController

    Provides access to the quick access providers.

    themeService: ThemeService

    Accessors

    Methods

    • Accept the selected item.

      Parameters

      • OptionalkeyMods: IKeyMods

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

      Returns Promise<void>

    • Provides raw access to the quick pick controller.

      Type Parameters

      • T extends IQuickPickItem

      Parameters

      • options: { useSeparators: true }

      Returns IQuickPick<T, { useSeparators: true }>

    • Type Parameters

      • T extends IQuickPickItem

      Parameters

      • options: { useSeparators: false }

      Returns IQuickPick<T, { useSeparators: false }>

    • 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>

    • Navigate inside the opened quick input list.

      Parameters

      • next: boolean
      • OptionalquickNavigate: IQuickNavigateConfiguration

      Returns void

    • 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)>