tsai
/
grapesjs
mirror of https://github.com/artf/grapesjs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Update Pages module docs

pull/3411/head
Artur Arseniev 5 years ago
parent
78622d211f
commit
452a6dd6cb
4 changed files with 96 additions and 70 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 142
      docs/api/editor.md
  2. 12
      docs/api/pages.md
  3. 2
      src/editor/index.js
  4. 10
      src/pages/index.js

142
docs/api/editor.md
View File

@ -127,6 +127,10 @@ editor.on('EVENT-NAME', (some, argument) => {
- `run` - Triggered on run of any command. The id and the result are passed as arguments to the callback
- `stop` - Triggered on stop of any command. The id and the result are passed as arguments to the callback
### Pages
Check the [Pages][2] module.
### General
- `canvasScroll` - Canvas is scrolled
@ -141,7 +145,7 @@ Returns configuration object
### Parameters
- `prop` **[string][2]?** Property name
- `prop` **[string][3]?** Property name
Returns **any** Returns the configuration object or
the value of the specified property
@ -152,10 +156,10 @@ Returns HTML built inside canvas
### Parameters
- `opts` **[Object][3]** Options (optional, default `{}`)
- `opts.cleanId` **[Boolean][4]** Remove unnecessary IDs (eg. those created automatically) (optional, default `false`)
- `opts` **[Object][4]** Options (optional, default `{}`)
- `opts.cleanId` **[Boolean][5]** Remove unnecessary IDs (eg. those created automatically) (optional, default `false`)
Returns **[string][2]** HTML string
Returns **[string][3]** HTML string
## getCss
@ -163,16 +167,16 @@ Returns CSS built inside canvas
### Parameters
- `opts` **[Object][3]** Options (optional, default `{}`)
- `opts.avoidProtected` **[Boolean][4]** Don't include protected CSS (optional, default `false`)
- `opts` **[Object][4]** Options (optional, default `{}`)
- `opts.avoidProtected` **[Boolean][5]** Don't include protected CSS (optional, default `false`)
Returns **[string][2]** CSS string
Returns **[string][3]** CSS string
## getJs
Returns JS of all components
Returns **[string][2]** JS string
Returns **[string][3]** JS string
## getComponents
@ -192,8 +196,8 @@ Set components inside editor's canvas. This method overrides actual components
### Parameters
- `components` **([Array][5]<[Object][3]> | [Object][3] \| [string][2])** HTML string or components model
- `opt` **[Object][3]** the options object to be used by the [setComponents][em#setComponents][6] method (optional, default `{}`)
- `components` **([Array][6]<[Object][4]> | [Object][4] \| [string][3])** HTML string or components model
- `opt` **[Object][4]** the options object to be used by the [setComponents][em#setComponents][7] method (optional, default `{}`)
### Examples
@ -215,9 +219,9 @@ Add components
### Parameters
- `components` **([Array][5]<[Object][3]> | [Object][3] \| [string][2])** HTML string or components model
- `opts` **[Object][3]** Options
- `opts.avoidUpdateStyle` **[Boolean][4]** If the HTML string contains styles,
- `components` **([Array][6]<[Object][4]> | [Object][4] \| [string][3])** HTML string or components model
- `opts` **[Object][4]** Options
- `opts.avoidUpdateStyle` **[Boolean][5]** If the HTML string contains styles,
by default, they will be created and, if already exist, updated. When this option
is true, styles already created will not be updated. (optional, default `false`)
@ -233,13 +237,13 @@ editor.addComponents({
});
```
Returns **[Array][5]<Component>**
Returns **[Array][6]<Component>**
## getStyle
Returns style in JSON format object
Returns **[Object][3]**
Returns **[Object][4]**
## setStyle
@ -247,8 +251,8 @@ Set style inside editor's canvas. This method overrides actual style
### Parameters
- `style` **([Array][5]<[Object][3]> | [Object][3] \| [string][2])** CSS string or style model
- `opt` **[Object][3]** the options object to be used by the [setStyle][em#setStyle][7] method (optional, default `{}`)
- `style` **([Array][6]<[Object][4]> | [Object][4] \| [string][3])** CSS string or style model
- `opt` **[Object][4]** the options object to be used by the [setStyle][em#setStyle][8] method (optional, default `{}`)
### Examples
@ -273,7 +277,7 @@ Returns **Model**
Returns an array of all selected components
Returns **[Array][5]**
Returns **[Array][6]**
## getSelectedToStyle
@ -291,9 +295,9 @@ Select a component
### Parameters
- `el` **(Component | [HTMLElement][8])** Component to select
- `opts` **[Object][3]?** Options
- `opts.scroll` **[Boolean][4]?** Scroll canvas to the selected element
- `el` **(Component | [HTMLElement][9])** Component to select
- `opts` **[Object][4]?** Options
- `opts.scroll` **[Boolean][5]?** Scroll canvas to the selected element
### Examples
@ -312,7 +316,7 @@ Add component to selection
### Parameters
- `el` **(Component | [HTMLElement][8] \| [Array][5])** Component to select
- `el` **(Component | [HTMLElement][9] \| [Array][6])** Component to select
### Examples
@ -328,7 +332,7 @@ Remove component from selection
### Parameters
- `el` **(Component | [HTMLElement][8] \| [Array][5])** Component to select
- `el` **(Component | [HTMLElement][9] \| [Array][6])** Component to select
### Examples
@ -344,7 +348,7 @@ Toggle component selection
### Parameters
- `el` **(Component | [HTMLElement][8] \| [Array][5])** Component to select
- `el` **(Component | [HTMLElement][9] \| [Array][6])** Component to select
### Examples
@ -361,7 +365,7 @@ change the canvas to the proper width
### Parameters
- `name` **[string][2]** Name of the device
- `name` **[string][3]** Name of the device
### Examples
@ -383,7 +387,7 @@ console.log(device);
// 'Tablet'
```
Returns **[string][2]** Device name
Returns **[string][3]** Device name
## runCommand
@ -391,8 +395,8 @@ Execute command
### Parameters
- `id` **[string][2]** Command ID
- `options` **[Object][3]** Custom options (optional, default `{}`)
- `id` **[string][3]** Command ID
- `options` **[Object][4]** Custom options (optional, default `{}`)
### Examples
@ -408,8 +412,8 @@ Stop the command if stop method was provided
### Parameters
- `id` **[string][2]** Command ID
- `options` **[Object][3]** Custom options (optional, default `{}`)
- `id` **[string][3]** Command ID
- `options` **[Object][4]** Custom options (optional, default `{}`)
### Examples
@ -425,9 +429,9 @@ Store data to the current storage
### Parameters
- `clb` **[Function][9]** Callback function
- `clb` **[Function][10]** Callback function
Returns **[Object][3]** Stored data
Returns **[Object][4]** Stored data
## load
@ -435,23 +439,23 @@ Load data from the current storage
### Parameters
- `clb` **[Function][9]** Callback function
- `clb` **[Function][10]** Callback function
Returns **[Object][3]** Stored data
Returns **[Object][4]** Stored data
## getContainer
Returns container element. The one which was indicated as 'container'
on init method
Returns **[HTMLElement][8]**
Returns **[HTMLElement][9]**
## getDirtyCount
Return the count of changes made to the content and not yet stored.
This count resets at any `store()`
Returns **[number][10]**
Returns **[number][11]**
## refresh
@ -464,8 +468,8 @@ refresh you'll get misleading position of tools
### Parameters
- `opts`
- `options` **[Object][3]?** Options
- `options.tools` **[Boolean][4]** Update the position of tools (eg. rich text editor, component highlighter, etc.) (optional, default `false`)
- `options` **[Object][4]?** Options
- `options.tools` **[Boolean][5]** Update the position of tools (eg. rich text editor, component highlighter, etc.) (optional, default `false`)
## setCustomRte
@ -473,7 +477,7 @@ Replace the built-in Rich Text Editor with a custom one.
### Parameters
- `obj` **[Object][3]** Custom RTE Interface
- `obj` **[Object][4]** Custom RTE Interface
### Examples
@ -513,7 +517,7 @@ custom parser, pass `null` as the argument
### Parameters
- `parser` **([Function][9] | null)** Parser function
- `parser` **([Function][10] | null)** Parser function
### Examples
@ -535,11 +539,11 @@ Returns **this**
## setDragMode
Change the global drag mode of components.
To get more about this feature read: [https://github.com/artf/grapesjs/issues/1936][11]
To get more about this feature read: [https://github.com/artf/grapesjs/issues/1936][12]
### Parameters
- `value` **[String][2]** Drag mode, options: 'absolute' | 'translate'
- `value` **[String][3]** Drag mode, options: 'absolute' | 'translate'
Returns **this**
@ -550,9 +554,9 @@ Trigger event log message
### Parameters
- `msg` **any** Message to log
- `opts` **[Object][3]** Custom options (optional, default `{}`)
- `opts.ns` **[String][2]** Namespace of the log (eg. to use in plugins) (optional, default `''`)
- `opts.level` **[String][2]** Level of the log, `debug`, `info`, `warning`, `error` (optional, default `'debug'`)
- `opts` **[Object][4]** Custom options (optional, default `{}`)
- `opts.ns` **[String][3]** Namespace of the log (eg. to use in plugins) (optional, default `''`)
- `opts.level` **[String][3]** Level of the log, `debug`, `info`, `warning`, `error` (optional, default `'debug'`)
### Examples
@ -574,10 +578,10 @@ Translate label
### Parameters
- `args` **...any**
- `key` **[String][2]** Label to translate
- `opts` **[Object][3]?** Options for the translation
- `opts.params` **[Object][3]?** Params for the translation
- `opts.noWarn` **[Boolean][4]?** Avoid warnings in case of missing resources
- `key` **[String][3]** Label to translate
- `opts` **[Object][4]?** Options for the translation
- `opts.params` **[Object][4]?** Params for the translation
- `opts.noWarn` **[Boolean][5]?** Avoid warnings in case of missing resources
### Examples
@ -589,7 +593,7 @@ editor.t('msg2', { params: { test: 'hello' } });
editor.t('msg2', { params: { test: 'hello' }, l: 'it' });
```
Returns **[String][2]**
Returns **[String][3]**
## on
@ -597,8 +601,8 @@ Attach event
### Parameters
- `event` **[string][2]** Event name
- `callback` **[Function][9]** Callback function
- `event` **[string][3]** Event name
- `callback` **[Function][10]** Callback function
Returns **this**
@ -608,8 +612,8 @@ Attach event and detach it after the first run
### Parameters
- `event` **[string][2]** Event name
- `callback` **[Function][9]** Callback function
- `event` **[string][3]** Event name
- `callback` **[Function][10]** Callback function
Returns **this**
@ -619,8 +623,8 @@ Detach event
### Parameters
- `event` **[string][2]** Event name
- `callback` **[Function][9]** Callback function
- `event` **[string][3]** Event name
- `callback` **[Function][10]** Callback function
Returns **this**
@ -630,7 +634,7 @@ Trigger event
### Parameters
- `event` **[string][2]** Event to trigger
- `event` **[string][3]** Event to trigger
Returns **this**
@ -642,26 +646,28 @@ Destroy the editor
Render editor
Returns **[HTMLElement][8]**
Returns **[HTMLElement][9]**
[1]: https://github.com/artf/grapesjs/blob/master/src/editor/config/config.js
[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[2]: /api/pages.html
[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
[6]: em#setComponents
[7]: em#setComponents
[7]: em#setStyle
[8]: em#setStyle
[8]: https://developer.mozilla.org/docs/Web/HTML/Element
[9]: https://developer.mozilla.org/docs/Web/HTML/Element
[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[11]: https://github.com/artf/grapesjs/issues/1936
[12]: https://github.com/artf/grapesjs/issues/1936

12
docs/api/pages.md
View File

@ -1,6 +1,6 @@
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
## PageManager
## Pages
You can customize the initial state of the module from the editor initialization
@ -25,6 +25,16 @@ Once the editor is instantiated you can use its API. Before using these methods
const pageManager = editor.Pages;
```
## Available Events
- `page:add` - Added new page. The page is passed as an argument to the callback
- `page:remove` - Page removed. The page is passed as an argument to the callback
- `page:select` - New page selected. The newly selected page and the previous one, are passed as arguments to the callback
- `page:update` - Page updated. The updated page and the object containing changes are passed as arguments to the callback
- `page` - Catch-all event for all the events mentioned above. An object containing all the available data about the triggered event is passed as an argument to the callback
## Methods
- [add][1]
- [get][2]
- [getAll][3]

2
src/editor/index.js
View File

@ -99,6 +99,8 @@
* * `abort:{commandName}` - Triggered when the command execution is aborted (`editor.on(`run:preview:before`, opts => opts.abort = 1);`)
* * `run` - Triggered on run of any command. The id and the result are passed as arguments to the callback
* * `stop` - Triggered on stop of any command. The id and the result are passed as arguments to the callback
* ### Pages
* Check the [Pages](/api/pages.html) module.
* ### General
* * `canvasScroll` - Canvas is scrolled
* * `update` - The structure of the template is updated (its HTML/CSS)

10
src/pages/index.js
View File

@ -21,6 +21,14 @@
* const pageManager = editor.Pages;
* ```
*
* ## Available Events
* * `page:add` - Added new page. The page is passed as an argument to the callback
* * `page:remove` - Page removed. The page is passed as an argument to the callback
* * `page:select` - New page selected. The newly selected page and the previous one, are passed as arguments to the callback
* * `page:update` - Page updated. The updated page and the object containing changes are passed as arguments to the callback
* * `page` - Catch-all event for all the events mentioned above. An object containing all the available data about the triggered event is passed as an argument to the callback
*
* ## Methods
* * [add](#add)
* * [get](#get)
* * [getAll](#getall)
@ -29,7 +37,7 @@
* * [select](#select)
* * [getSelected](#getselected)
*
* @module PageManager
* @module Pages
*/
import { isString, bindAll } from 'underscore';

Write Preview
Loading…
Cancel
Save