diff --git a/docs/api/canvas.md b/docs/api/canvas.md index 7a2c3c65d..a2da0a098 100644 --- a/docs/api/canvas.md +++ b/docs/api/canvas.md @@ -15,7 +15,7 @@ const editor = grapesjs.init({ Once the editor is instantiated you can use its API. Before using these methods you should get the module from the instance ```js -const blockManager = editor.Canvas; +const canvas = editor.Canvas; ``` - [getConfig][2] diff --git a/docs/api/commands.md b/docs/api/commands.md index 2e4e57b76..c1b75cbb1 100644 --- a/docs/api/commands.md +++ b/docs/api/commands.md @@ -20,9 +20,12 @@ const commands = editor.Commands; - [add][2] - [get][3] -- [has][4] -- [run][5] -- [stop][6] +- [getAll][4] +- [has][5] +- [run][6] +- [stop][7] +- [isActive][8] +- [getActive][9] ## add @@ -30,8 +33,8 @@ Add new command to the collection ### Parameters -- `id` **[string][7]** Command's ID -- `command` **([Object][8] \| [Function][9])** Object representing your command, +- `id` **[string][10]** Command's ID +- `command` **([Object][11] \| [Function][12])** 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). @@ -57,7 +60,7 @@ Get command by ID ### Parameters -- `id` **[string][7]** Command's ID +- `id` **[string][10]** Command's ID ### Examples @@ -66,7 +69,7 @@ var myCommand = commands.get('myCommand'); myCommand.run(); ``` -Returns **[Object][8]** Object representing the command +Returns **[Object][11]** Object representing the command ## has @@ -74,9 +77,15 @@ Check if command exists ### Parameters -- `id` **[string][7]** Command's ID +- `id` **[string][10]** Command's ID -Returns **[Boolean][10]** +Returns **[Boolean][13]** + +## getAll + +Get an object containing all the commands + +Returns **[Object][11]** ## run @@ -84,8 +93,8 @@ Execute the command ### Parameters -- `id` **[String][7]** Command ID -- `options` **[Object][8]** Options (optional, default `{}`) +- `id` **[String][10]** Command ID +- `options` **[Object][11]** Options (optional, default `{}`) ### Examples @@ -101,8 +110,8 @@ Stop the command ### Parameters -- `id` **[String][7]** Command ID -- `options` **[Object][8]** Options (optional, default `{}`) +- `id` **[String][10]** Command ID +- `options` **[Object][11]** Options (optional, default `{}`) ### Examples @@ -112,22 +121,65 @@ commands.stop('myCommand', { someOption: 1 }); Returns **any** The return is defined by the command +## isActive + +Check if the command is active. You activate commands with `run` +and disable them with `stop`. If the command was created without `stop` +method it can't be registered as active + +### Parameters + +- `id` **[String][10]** Command id + +### Examples + +```javascript +const cId = 'some-command'; +commands.run(cId); +commands.isActive(cId); +// -> true +commands.stop(cId); +commands.isActive(cId); +// -> false +``` + +Returns **[Boolean][13]** + +## getActive + +Get all active commands + +### Examples + +```javascript +console.log(commands.getActive()); +// -> { someCommand: itsLastReturn, anotherOne: ... }; +``` + +Returns **[Object][11]** + [1]: https://github.com/artf/grapesjs/blob/master/src/commands/config/config.js [2]: #add [3]: #get -[4]: #has +[4]: #getall + +[5]: #has + +[6]: #run + +[7]: #stop -[5]: #run +[8]: #isactive -[6]: #stop +[9]: #getactive -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function +[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function -[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean +[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean