Home Reference Source
import {CommandPalette} from './ui/dialogs/commandpalette.js'
public class | source

CommandPalette

show a searchable command palette (cmd/ctrl+p)

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

: *

public

dynamicCmds: import("../commands/commands.js").CommandObject[]

Private Members
private
private
private
private
private
private
private

bg: *

private
private

id: *

private
private

Method Summary

Public Methods
public

addDynamic(category: string, title: string, func: Function, icon: string): *

public

addResult(cmd: Object, num: Number, idx: Number): String

add result

public

close()

public

doSearch(str: String)

public

execIndex(el: *)

public

getBookmarkIconForCmd(cmdName: String): *

public

isCmdInSidebar(cmdName: string): *

public

isVisible(): *

public

keyDown(e: KeyboardEvent)

public

navigate(dir: number)

public

onBookmarkIconClick(ev: MouseEvent)

public

onResultClick(ev: PointerEvent)

public

removeDynamic(id: string)

public

show()

Public Constructors

public constructor(options: CommandPaletteOptions) source

Params:

NameTypeAttributeDescription
options CommandPaletteOptions

Public Members

public : * source

public dynamicCmds: import("../commands/commands.js").CommandObject[] source

Private Members

private _bookmarkActiveIcon: * source

private _bookmarkInactiveIcon: * source

private _defaultIcon: * source

private _findTimeoutId: * source

private _lastSearch: * source

private _numResults: * source

private bg: * source

private cursorIndex: * source

private id: * source

private options: CommandPaletteOptions source

private resultCommands: * source

Public Methods

public addDynamic(category: string, title: string, func: Function, icon: string): * source

Params:

NameTypeAttributeDescription
category string
title string
func Function
icon string

Return:

*

public addResult(cmd: Object, num: Number, idx: Number): String source

add result

Params:

NameTypeAttributeDescription
cmd Object
num Number
idx Number

Return:

String

public close() source

public doSearch(str: String) source

Params:

NameTypeAttributeDescription
str String

String

public execIndex(el: *) source

Params:

NameTypeAttributeDescription
el *

public getBookmarkIconForCmd(cmdName: String): * source

Params:

NameTypeAttributeDescription
cmdName String

Return:

*

public isCmdInSidebar(cmdName: string): * source

Params:

NameTypeAttributeDescription
cmdName string

Return:

*

public isVisible(): * source

Return:

*

public keyDown(e: KeyboardEvent) source

Params:

NameTypeAttributeDescription
e KeyboardEvent

public navigate(dir: number) source

Params:

NameTypeAttributeDescription
dir number
  • optional

public onBookmarkIconClick(ev: MouseEvent) source

Params:

NameTypeAttributeDescription
ev MouseEvent

public onResultClick(ev: PointerEvent) source

Params:

NameTypeAttributeDescription
ev PointerEvent

public removeDynamic(id: string) source

Params:

NameTypeAttributeDescription
id string

public show() source