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

    Implements

    • IQuickInputService
    Index
    _serviceBrand: undefined
    colorRegistry: MonacoColorRegistry
    container: HTMLElement

    The container hosting the quick input in the main window.

    controller: QuickInputController
    inQuickOpen: IContextKey<boolean>
    previousFocusElement: HTMLElement | undefined

    The element that had focus when the quick input was shown. Cleared when the quick input is hidden.

    quickAccess: IQuickAccessController

    Provides access to the quick access providers.

    scopedContextKeyService: IScopedContextKeyService

    Help keybinding service prioritize keybindings when this element is focused.

    scopedInQuickOpen: IContextKey<boolean>

    Help keybinding service prioritize keybindings when this element is focused.

    secondaryContainers: Map<
        Window,
        {
            container: HTMLElement;
            scopedContextKeyService: IScopedContextKeyService;
            scopedInQuickOpen: IContextKey<boolean>;
        },
    > = ...

    The containers hosting the quick input in secondary windows, see getContainer.

    secondaryWindowService: SecondaryWindowService
    themeService: ThemeService
    windowFocusService: WindowFocusService
    • Accept the selected item.

      Parameters

      • OptionalkeyMods: IKeyMods

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

      Returns Promise<void>

    • Creates the layout service of the quick input controller. The controller moves the quick input to the activeContainer of the layout service whenever it is shown, which is the container of the focused window, so that the quick input is shown in secondary windows as well.

      Parameters

      • delegate: ILayoutService

      Returns ILayoutService

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

    • Provides raw access to the quick tree controller.

      Type Parameters

      • T extends IQuickTreeItem

        The type of items in the quick tree.

      Returns IQuickTree<T>

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

    • 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<(O extends { canPickMany: true } ? T[] : T) | undefined>

    • Set the alignment of the quick input.

      Parameters

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

        either a preset or a custom alignment

      Returns void