Construct a new command palette.
The options for initializing the palette.
Private
_activePrivate
_itemsPrivate
_resultsReadonly
commandsThe command registry used by the command palette.
Readonly
nodeGet the DOM node owned by the widget.
Readonly
rendererThe renderer used by the command palette.
The command palette content node.
This is the node which holds the command item nodes.
Modifying this node directly can lead to undefined behavior.
The dataset for the widget's DOM node.
Get the method for hiding the widget.
Set the method for hiding the widget.
Get the id of the widget's DOM node.
Set the id of the widget's DOM node.
Test whether the widget's node is attached to the DOM.
Test whether the widget has been disposed.
Test whether the widget is explicitly hidden.
Test whether the widget is visible.
A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.
A read-only array of the command items in the palette.
Get the layout for the widget.
Set the layout for the widget.
The layout is single-use only. It cannot be changed after the first assignment.
The layout is disposed automatically when the widget is disposed.
Get the parent of the widget.
Set the parent of the widget.
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.
The title object for the widget.
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.
Private
_activatePrivate
_activatePrivate
_evtHandle the 'click'
event for the command palette.
Private
_evtHandle the 'keydown'
event for the command palette.
Private
_executePrivate
_onPrivate
_togglePost an 'activate-request'
message to the widget.
This is a simple convenience method for posting the message.
Add a class name to the widget's DOM node.
The class name to add to the node.
If the class name is already added to the node, this is a no-op.
The class name must not contain whitespace.
Add a command item to the command palette.
The options for creating the command item.
The command item added to the palette.
Adds command items to the command palette.
An array of options for creating each command item.
The command items added to the palette.
Create an iterator over the widget's children.
A new iterator over the children of the widget.
The widget must have a populated layout in order to have children.
If a layout is not installed, the returned iterator will be empty.
Send a 'close-request'
message to the widget.
This is a simple convenience method for sending the message.
Test whether a widget is a descendant of this widget.
The descendant widget of interest.
true
if the widget is a descendant, false
otherwise.
Post a 'fit-request'
message to the widget.
This is a simple convenience method for posting the message.
Protected
notifyProtected
onA message handler invoked on an 'activate-request'
message.
Protected
onProtected
onA message handler invoked on an 'after-detach'
message.
Protected
onProtected
onA message handler invoked on an 'after-show'
message.
Protected
onA message handler invoked on a 'before-attach'
message.
Protected
onProtected
onProtected
onProtected
onA message handler invoked on a 'child-added'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'child-removed'
message.
The default implementation of this handler is a no-op.
Protected
onProtected
onProtected
onA message handler invoked on a 'resize'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'update-request'
message.
Process a message sent to the widget.
Clear the search results and schedule an update.
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.
Remove a class name from the widget's DOM node.
The class name to remove from the node.
If the class name is not yet added to the node, this is a no-op.
The class name must not contain whitespace.
Remove an item from the command palette.
Show or hide the widget according to a boolean value.
true
to hide the widget, or false
to show it.
This is a convenience method for hide()
and show()
.
Toggle a class name on the widget's DOM node.
The class name to toggle on the node.
Optional
force: booleanWhether 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.
true
if the class is now present, false
otherwise.
The class name must not contain whitespace.
Post an 'update-request'
message to the widget.
This is a simple convenience method for posting the message.
A widget which displays command items as a searchable palette.