grapesjs/docs/api/commands.md

Commands

You can customize the initial state of the module from the editor initialization, by passing the following Configuration Object

const editor = grapesjs.init({
 commands: {
   // options
 }
})

Once the editor is instantiated you can use its API. Before using these methods you should get the module from the instance

const commands = editor.Commands;

• add
• get
• has

add

Add new command to the collection

Parameters

• id string Command's ID
• command (Object | Function) Object representing your command, By passing just a function it's intended as a stateless command (just like passing an object with only run method).

Examples

commands.add('myCommand', {
	run(editor, sender) {
		alert('Hello world!');
	},
	stop(editor, sender) {
	},
});
// As a function
commands.add('myCommand2', editor => { ... });

Returns this

get

Get command by ID

Parameters

• id string Command's ID

Examples

var myCommand = commands.get('myCommand');
myCommand.run();

Returns Object Object representing the command

has

Check if command exists

Parameters

• id string Command's ID

Returns Boolean