Update Canvas jsdoc

docs/api.js

@@ -40,9 +40,10 @@ async function generateDocs () {
     ['rich_text_editor/index.js', 'rich_text_editor.md'],
     ['keymaps/index.js', 'keymaps.md'],
     ['undo_manager/index.js', 'undo_manager.md'],
-    ['canvas/index.js', 'canvas.md'],
+    ['canvas/index.ts', 'canvas.md'],
     ['canvas/model/Frame.ts', 'frame.md'],
     ['i18n/index.js', 'i18n.md'],
+    ['navigator/index.ts', 'layer_manager.md'],
     ['pages/index.ts', 'pages.md'],
     ['pages/model/Page.ts', 'page.md'],
     ['parser/index.js', 'parser.md'],

docs/api/canvas.md

@@ -55,15 +55,9 @@ By changing `result.content` you're able to customize what is dropped
 
 ## getConfig
 
-Get the configuration object
+Get configuration object
 
-### Examples
+Returns **[Object][15]** 
-
-```javascript
-console.log(canvas.getConfig())
-```
-
-Returns **[Object][15]** Configuration object
 
 ## getElement
 

docs/api/component.md

@@ -485,6 +485,12 @@ component.parent();
 
 Returns **(Component | null)** 
 
+## parents
+
+Return all parents of the component.
+
+Returns **[Array][5]\<Component>** 
+
 ## getTraits
 
 Get traits.

docs/api/layer_manager.md

@@ -0,0 +1,139 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## Layers
+
+You can customize the initial state of the module from the editor initialization
+
+```js
+const editor = grapesjs.init({
+ // ...
+ layerManager: {
+   // ...
+ },
+})
+```
+
+Once the editor is instantiated you can use its API. Before using these methods you should get the module from the instance
+
+```js
+const layers = editor.Layers;
+```
+
+## Available Events
+
+*   `layer:root` - Root layer changed. The new root component is passed as an argument to the callback.
+*   `layer:component` - Component layer is updated. The updated component is passed as an argument to the callback.
+
+## Methods
+
+*   [setRoot][1]
+*   [getRoot][2]
+*   [getLayerData][3]
+
+[Page]: page.html
+
+[Component]: component.html
+
+## setRoot
+
+Update root layer with another component.
+
+### Parameters
+
+*   `component` **([Component] | [String][4])** Component to be set as root
+
+### Examples
+
+```javascript
+const component = editor.getSelected();
+layers.setRoot(component);
+```
+
+Returns **[Component]** 
+
+## getRoot
+
+Get the current root layer.
+
+### Examples
+
+```javascript
+const layerRoot = layers.getRoot();
+```
+
+Returns **[Component]** 
+
+## getLayerData
+
+Get layer data from a component.
+
+### Parameters
+
+*   `component` **[Component]** Component from which you want to read layer data.
+
+### Examples
+
+```javascript
+const component = editor.getSelected();
+const layerData = layers.getLayerData(component);
+console.log(layerData);
+```
+
+Returns **LayerData** Object containing layer data
+
+## setVisible
+
+Update component visibility
+
+### Parameters
+
+*   `component` **Component** 
+*   `value` **[boolean][5]** 
+
+## isVisible
+
+Check if the component is visible
+
+### Parameters
+
+*   `component` **Component** 
+
+Returns **[boolean][5]** 
+
+## setLocked
+
+Update component locked value
+
+### Parameters
+
+*   `component` **Component** 
+*   `value` **[boolean][5]** 
+
+## isLocked
+
+Check if the component is locked
+
+### Parameters
+
+*   `component` **Component** 
+
+Returns **[boolean][5]** 
+
+## setName
+
+Update component name
+
+### Parameters
+
+*   `component` **Component** 
+*   `value` **[string][4]** 
+
+[1]: #setroot
+
+[2]: #getroot
+
+[3]: #getlayerdata
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean

src/canvas/index.ts

@@ -60,6 +60,13 @@ import CanvasView from './view/CanvasView';
 import FrameView from './view/FrameView';
 
 export default class CanvasModule extends Module<typeof defaults> {
+  /**
+   * Get configuration object
+   * @name getConfig
+   * @function
+   * @return {Object}
+   */
+
   /**
    * Used inside RTE
    * @private