Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommandPalette

A widget which displays command items as a searchable palette. The namespace for the CommandPalette class statics.

Hierarchy

Implements

  • IMessageHandler
  • IObservableDisposable

Index

Modules

Enumerations

Classes

Interfaces

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _activeIndex

_activeIndex: number = -1

Private _items

_items: IItem[] = []

Private _results

_results: Private.SearchResult[] | null = null

commands

commands: CommandRegistry

The command registry used by the command palette.

node

node: HTMLElement

Get the DOM node owned by the widget.

renderer

renderer: IRenderer

The renderer used by the command palette.

Static defaultRenderer

defaultRenderer: Renderer = new Renderer()

The default Renderer instance.

Accessors

contentNode

  • get contentNode(): HTMLUListElement

  • The command palette content node.

    Notes

    This is the node which holds the command item nodes.

    Modifying this node directly can lead to undefined behavior.

    Returns HTMLUListElement

dataset

  • get dataset(): DOMStringMap

disposed

  • get disposed(): ISignal<this, void>

hiddenMode

id

  • get id(): string
  • set id(value: string): void

inputNode

  • get inputNode(): HTMLInputElement

isAttached

  • get isAttached(): boolean

isDisposed

  • get isDisposed(): boolean

isHidden

  • get isHidden(): boolean

isVisible

  • get isVisible(): boolean

  • Test whether the widget is visible.

    Notes

    A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

    Returns boolean

items

  • get items(): ReadonlyArray<IItem>

layout

  • get layout(): Layout | null
  • set layout(value: Layout | null): void

  • Get the layout for the widget.

    Notes

    The layout is single-use only. It cannot be changed after the first assignment.

    The layout is disposed automatically when the widget is disposed.

    Returns Layout | null

  • Set the layout for the widget.

    Notes

    The layout is single-use only. It cannot be changed after the first assignment.

    The layout is disposed automatically when the widget is disposed.

    Parameters

    Returns void

parent

  • get parent(): Widget | null
  • set parent(value: Widget | null): void

  • Get the parent of the widget.

    Notes

    Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

    The widget will be automatically removed from its old parent.

    This is a no-op if there is no effective parent change.

    Returns Widget | null

  • Set the parent of the widget.

    Notes

    Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

    The widget will be automatically removed from its old parent.

    This is a no-op if there is no effective parent change.

    Parameters

    Returns void

searchNode

  • get searchNode(): HTMLDivElement

title

  • The title object for the widget.

    Notes

    The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

    Since not all widgets will use the title, it is created on demand.

    The owner property of the title is set to this widget.

    Returns Title<Widget>

Methods

Private _activateNextItem

  • _activateNextItem(): void

Private _activatePreviousItem

  • _activatePreviousItem(): void

Private _evtClick

  • _evtClick(event: MouseEvent): void

Private _evtKeyDown

  • _evtKeyDown(event: KeyboardEvent): void

Private _execute

  • _execute(index: number): void

Private _onGenericChange

  • _onGenericChange(): void

Private _toggleFocused

  • _toggleFocused(): void

activate

  • activate(): void

addClass

  • addClass(name: string): void

  • Add a class name to the widget's DOM node.

    Parameters

    • name: string

      The class name to add to the node.

      Notes

      If the class name is already added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

addItem

addItems

children

  • children(): IIterator<Widget>

  • Create an iterator over the widget's children.

    Returns IIterator<Widget>

    A new iterator over the children of the widget.

    Notes

    The widget must have a populated layout in order to have children.

    If a layout is not installed, the returned iterator will be empty.

clearFlag

  • clearFlag(flag: Flag): void

clearItems

  • clearItems(): void

close

  • close(): void

contains

  • contains(widget: Widget): boolean

  • Test whether a widget is a descendant of this widget.

    Parameters

    • widget: Widget

      The descendant widget of interest.

    Returns boolean

    true if the widget is a descendant, false otherwise.

dispose

  • dispose(): void

fit

  • fit(): void

handleEvent

  • handleEvent(event: Event): void

  • Handle the DOM events for the command palette.

    Parameters

    • event: Event

      The DOM event sent to the command palette.

      Notes

      This method implements the DOM EventListener interface and is called in response to events on the command palette's DOM node. It should not be called directly by user code.

    Returns void

hasClass

  • hasClass(name: string): boolean

  • Test whether the widget's DOM node has the given class name.

    Parameters

    • name: string

      The class name of interest.

    Returns boolean

    true if the node has the class, false otherwise.

hide

  • hide(): void

Protected notifyLayout

  • notifyLayout(msg: Message): void

  • Invoke the message processing routine of the widget's layout.

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      This is a no-op if the widget does not have a layout.

      This will not typically be called directly by user code.

    Returns void

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void

Protected onAfterHide

  • onAfterHide(msg: Message): void

Protected onAfterShow

  • onAfterShow(msg: Message): void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

Protected onBeforeHide

  • onBeforeHide(msg: Message): void

Protected onBeforeShow

  • onBeforeShow(msg: Message): void

Protected onChildAdded

Protected onChildRemoved

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

Protected onFitRequest

  • onFitRequest(msg: Message): void

Protected onResize

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

processMessage

  • processMessage(msg: Message): void

refresh

  • refresh(): void

  • Clear the search results and schedule an update.

    Notes

    This should be called whenever the search results of the palette should be updated.

    This is typically called automatically by the palette as needed, but can be called manually if the input text is programatically changed.

    The rendered results are updated asynchronously.

    Returns void

removeClass

  • removeClass(name: string): void

  • Remove a class name from the widget's DOM node.

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      If the class name is not yet added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

removeItem

  • removeItem(item: IItem): void

removeItemAt

  • removeItemAt(index: number): void

  • Remove the item at a given index from the command palette.

    Parameters

    • index: number

      The index of the item to remove.

      Notes

      This is a no-op if the index is out of range.

    Returns void

setFlag

  • setFlag(flag: Flag): void

setHidden

  • setHidden(hidden: boolean): void

  • Show or hide the widget according to a boolean value.

    Parameters

    • hidden: boolean

      true to hide the widget, or false to show it.

      Notes

      This is a convenience method for hide() and show().

    Returns void

show

  • show(): void

testFlag

  • testFlag(flag: Flag): boolean

toggleClass

  • toggleClass(name: string, force?: undefined | false | true): boolean

  • Toggle a class name on the widget's DOM node.

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: undefined | false | true

      Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

    Returns boolean

    true if the class is now present, false otherwise.

    Notes

    The class name must not contain whitespace.

update

  • update(): void

Static attach

  • attach(widget: Widget, host: HTMLElement, ref?: HTMLElement | null): void

  • Attach a widget to a host DOM node.

    Parameters

    • widget: Widget

      The widget of interest.

    • host: HTMLElement

      The DOM node to use as the widget's host.

    • Default value ref: HTMLElement | null = null

      The child of host to use as the reference element. If this is provided, the widget will be inserted before this node in the host. The default is null, which will cause the widget to be added as the last child of the host.

      Notes

      This will throw an error if the widget is not a root widget, if the widget is already attached, or if the host is not attached to the DOM.

    Returns void

Static detach

  • detach(widget: Widget): void

  • Detach the widget from its host DOM node.

    Parameters

    • widget: Widget

      The widget of interest.

      Notes

      This will throw an error if the widget is not a root widget, or if the widget is not attached to the DOM.

    Returns void

Generated using TypeDoc