Browse Source

Up API docs

canvas-spot v0.21.4
Artur Arseniev 3 years ago
parent
commit
839563fa55
  1. 15
      docs/api/block_manager.md
  2. 9
      docs/api/canvas.md

15
docs/api/block_manager.md

@ -151,6 +151,13 @@ Return the Blocks container element
Returns **[HTMLElement][14]**
## getDragBlock
Returns currently dragging block.
Updated when the drag starts and cleared once it's done.
Returns **([Block] | [undefined][15])**
## render
Render blocks
@ -160,8 +167,8 @@ Render blocks
* `blocks` **[Array][13]** Blocks to render, without the argument will render all global blocks
* `opts` **[Object][11]** Options (optional, default `{}`)
* `opts.external` **[Boolean][15]?** Render blocks in a new container (HTMLElement will be returned)
* `opts.ignoreCategories` **[Boolean][15]?** Render blocks without categories
* `opts.external` **[Boolean][16]?** Render blocks in a new container (HTMLElement will be returned)
* `opts.ignoreCategories` **[Boolean][16]?** Render blocks without categories
### Examples
@ -217,4 +224,6 @@ Returns **[HTMLElement][14]** Rendered element
[14]: https://developer.mozilla.org/docs/Web/HTML/Element
[15]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[15]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined
[16]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean

9
docs/api/canvas.md

@ -178,6 +178,7 @@ Set canvas position coordinates
* `x` **[Number][22]** Horizontal position
* `y` **[Number][22]** Vertical position
* `opts` **ToWorldOption** (optional, default `{}`)
### Examples
@ -233,6 +234,12 @@ canvas.addFrame({
Returns **[Frame]**
## getLastDragResult
Get the last created Component from a drag & drop to the canvas.
Returns **([Component] | [undefined][23])**
[1]: https://github.com/GrapesJS/grapesjs/blob/master/src/canvas/config/config.ts
[2]: #getconfig
@ -276,3 +283,5 @@ Returns **[Frame]**
[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[22]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[23]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined

Loading…
Cancel
Save