Browse Source

Up docs

pull/5605/head
Artur Arseniev 3 years ago
parent
commit
664f0dee0a
  1. 24
      docs/api/canvas.md
  2. 8
      docs/api/component.md
  3. 14
      docs/api/selector.md

24
docs/api/canvas.md

@ -90,6 +90,30 @@ editor.on('canvas:pointer', () => {
});
```
* `canvas:frame:load` Frame loaded in canvas.
The event is triggered right after iframe's `onload`.
```javascript
editor.on('canvas:frame:load', ({ window }) => {
console.log('Frame loaded', window);
});
```
* `canvas:frame:load:head` Frame head loaded in canvas.
The event is triggered right after iframe's finished to load the head elemenets (eg. scripts)
```javascript
editor.on('canvas:frame:load:head', ({ window }) => {
console.log('Frame head loaded', window);
});
```
* `canvas:frame:load:body` Frame body loaded in canvas.
The event is triggered when the body is rendered with components.
```javascript
editor.on('canvas:frame:load:body', ({ window }) => {
console.log('Frame completed the body render', window);
});
```
[Component]: component.html
[Frame]: frame.html

8
docs/api/component.md

@ -62,6 +62,7 @@ component.get('tagName');
Eg. `toolbar: [ { attributes: {class: 'fa fa-arrows'}, command: 'tlb-move' }, ... ]`.
By default, when `toolbar` property is falsy the editor will add automatically commands `core:component-exit` (select parent component, added if there is one), `tlb-move` (added if `draggable`) , `tlb-clone` (added if `copyable`), `tlb-delete` (added if `removable`).
* `components` **Collection\<Component>?** Children components. Default: `null`
* `delegate` **[Object][2]?** Delegate commands to other components. Available commands `remove` | `move` | `copy` | `select`. eg. `{ remove: (cmp) => cmp.closestType('other-type') }`
## init
@ -219,15 +220,16 @@ Replace a component with another one
### Parameters
* `el` **([String][1] | Component)** Component or HTML string
* `opts` **[Object][2]** Options for the append action (optional, default `{}`)
### Examples
```javascript
component.replaceWith('<div>Some new content</div>');
// -> Component
const result = component.replaceWith('<div>Some new content</div>');
// result -> [Component]
```
Returns **(Component | [Array][5]\<Component>)** New added component/s
Returns **[Array][5]\<Component>** New replaced components
## setAttributes

14
docs/api/selector.md

@ -27,6 +27,20 @@ console.log(selector.toString());
Returns **[String][1]**
### getName
Get selector name.
#### Examples
```javascript
// Given such selector: { name: 'my-selector', label: 'My selector' }
console.log(selector.getName());
// -> `my-selector`
```
Returns **[String][1]**
### getLabel
Get selector label.

Loading…
Cancel
Save