1. Home
  2. Classes
  3. PaletteCommand

new PaletteCommand( [ options ] )

Description

Default options is litteraly


			const defaultOptions = {
			 isShortcut: event => event.ctrlKey && event.altKey && event.key === 'p',
			 navigationCallback(event) {
			   switch (event.key) {
			     case 'ArrowDown':
			       this.next();
			       break;
			     case 'ArrowUp':
			       this.prev();
			       break;
			     case 'Enter':
			       this.dispatch();
			       break;
			   }
			 }
			}
Parameters
Name Type Attributes Default Description
options PaletteCommand~ConstructorOptions <optional>
 {}

Options for palette
Properties
Name Type Description
options PaletteCommand~ConstructorOptions

Merged options (Object.assign) you give to constructor with default options
Details

PaletteCommand.js, line 57

Methods

setCategory( commands [, category ] )

If no category specified, merge commands in generic category
else replace existent category (if exist) with this set of commands

.

Description

If no category specified, merge commands in generic category
else replace existent category (if exist) with this set of commands

Parameters
Name Type Attributes Default Description
commands Array.<PaletteCommand~Command>
category string | symbol <optional>
 ''
Examples

			// add commands to default context
			palette.setCategory([
			 {
			   name: 'foo',
			   description: 'log `foo` in console'
			   action() {
			     console.log('foo');
			   }
			 }
			]);
			
			// replace `Bar` context
			palette.setCategory([
			 {
			   name: 'foo',
			   description: 'log `foo` in console'
			   action() {
			     console.log('foo');
			   }
			 }
			], 'Bar');
Details

PaletteCommand.js, line 163

removeCategory( category )

Parameters
Name Type Description
category string | symbol
Details

PaletteCommand.js, line 173

addToCategory( commands [, category ] )

Add list (or single) Command to the category

.

Description

Add list (or single) Command to the category

Parameters
Name Type Attributes Default Description
commands PaletteCommand~Command | Array.<PaletteCommand~Command>
category string | symbol <optional>
 ''

Generic category if not specified
Details

PaletteCommand.js, line 186

show()

lazy load the command palette and display it

.

Description

lazy load the command palette and display it

Details

PaletteCommand.js, line 261

hide()

lazy load the command palette and hide it

.

Description

lazy load the command palette and hide it

Details

PaletteCommand.js, line 270

isShow() → {boolean}

lazy load the command palette and return if it display

.

Description

lazy load the command palette and return if it display

Returns
Details

PaletteCommand.js, line 280

isHide() → {boolean}

lazy load the command palette and return if it not display

.

Description

lazy load the command palette and return if it not display

Returns
Details

PaletteCommand.js, line 289

next()

lazy load the palette
and select next item in command list

.

Description

lazy load the palette
and select next item in command list

Details

PaletteCommand.js, line 307

prev()

lazy load the palette
and select previous item in command list

.

Description

lazy load the palette
and select previous item in command list

Details

PaletteCommand.js, line 331

lazy load palette
and hide items whose not respect the fuzzySearch terms

.

Description

lazy load palette
and hide items whose not respect the fuzzySearch terms

Parameters
Name Type Description
text string
Details

PaletteCommand.js, line 386

dispatch()

lazy load palette
and run selected command

.

Description

lazy load palette
and run selected command

Details

PaletteCommand.js, line 413

destroy()

Remove PaletteCommand from DOM

.

Description

Remove PaletteCommand from DOM

Details

PaletteCommand.js, line 458

Type Definitions

Command

Properties
Name Type Attributes Description
name string | symbol

Name of command (print in palette after category name)
description string <optional>

Detail text for explain action of command
action function

Callback when user press Enter on command when selected
Details
object

PaletteCommand.js, line 1

ConstructorOptionsNavigation( event )

Parameters
Name Type Description
event KeyboardEvent

keypress event from document
Details
function

PaletteCommand.js, line 14

ConstructorOptions

Properties
Name Type Attributes Description
cssClass string <optional>

add if you want stylize the palette with your own css ;-)
isShortcut PaletteCommand~ConstructorOptionsShortcut <optional>

take a KeyboardEvent and return if right shortcut, by default the shortcut is ctrl-alt-p
navigationCallback PaletteCommand~ConstructorOptionsNavigation <optional>

take a KeyboardEvent and execute your navigation
Details
object

PaletteCommand.js, line 20

ConstructorOptionsShortcut( event ) → {boolean}

Parameters
Name Type Description
event KeyboardEvent

keypress event from document
Returns
  • return true if keypress event is your shortcut
Details
function

PaletteCommand.js, line 8