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

Up pages doc

pull/5694/head
Artur Arseniev 3 years ago
parent
a5ac7af6d2
commit
c2c6cdfc0b
2 changed files with 36 additions and 63 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 82
      docs/api/pages.md
  2. 17
      src/pages/index.ts

82
docs/api/pages.md
View File

@ -26,33 +26,39 @@ const pageManager = editor.Pages;
``` ```
## Available Events ## Available Events
* `page:add` Added new page. The page is passed as an argument to the callback.
* `page:add` - Added new page. The page is passed as an argument to the callback ```javascript
* `page:remove` - Page removed. The page is passed as an argument to the callback editor.on('page:add', (page) => { ... });
* `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 * `page:remove` Page removed. The page is passed as an argument to the callback.
* [add][1] ```javascript
* [get][2] editor.on('page:remove', (page) => { ... });
* [getAll][3] ```
* [getAllWrappers][4]
* [getMain][5]
* [remove][6]
* [select][7]
* [getSelected][8]
[Page]: page.html * `page:select` New page selected. The newly selected page and the previous one, are passed as arguments to the callback.
[Component]: component.html ```javascript
editor.on('page:select', (page, previousPage) => { ... });
```
## select * `page:update` Page updated. The updated page and the object containing changes are passed as arguments to the callback.
Select the page. ```javascript
editor.on('page:update', (page, changes) => { ... });
```
Type: [boolean][9] * `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.
```javascript
editor.on('page', ({ event, model, ... }) => { ... });
```
[Page]: page.html
[Component]: component.html
## getAll ## getAll
@ -64,7 +70,7 @@ Get all pages
const arrayOfPages = pageManager.getAll(); const arrayOfPages = pageManager.getAll();
``` ```
Returns **[Array][10]<[Page]>** Returns **[Array][1]<[Page]>**
## add ## add
@ -72,8 +78,8 @@ Add new page
### Parameters ### Parameters
* `props` **[Object][11]** Page properties * `props` **[Object][2]** Page properties
* `opts` **[Object][11]?** Options (optional, default `{}`) * `opts` **[Object][2]?** Options (optional, default `{}`)
### Examples ### Examples
@ -93,7 +99,7 @@ Remove page
### Parameters ### Parameters
* `page` **([String][12] | [Page])** Page or page id * `page` **([String][3] | [Page])** Page or page id
* `opts` **any** (optional, default `{}`) * `opts` **any** (optional, default `{}`)
### Examples ### Examples
@ -113,7 +119,7 @@ Get page by id
### Parameters ### Parameters
* `id` **[String][12]** Page id * `id` **[String][3]** Page id
### Examples ### Examples
@ -147,7 +153,7 @@ const wrappers = pageManager.getAllWrappers();
const allImages = wrappers.map(wrp => wrp.findType('image')).flat(); const allImages = wrappers.map(wrp => wrp.findType('image')).flat();
``` ```
Returns **[Array][10]<[Component]>** Returns **[Array][1]<[Component]>**
## select ## select
@ -155,7 +161,7 @@ Change the selected page. This will switch the page rendered in canvas
### Parameters ### Parameters
* `page` **([String][12] | [Page])** Page or page id * `page` **([String][3] | [Page])** Page or page id
* `opts` **SetOptions** (optional, default `{}`) * `opts` **SetOptions** (optional, default `{}`)
### Examples ### Examples
@ -181,26 +187,8 @@ const selectedPage = pageManager.getSelected();
Returns **[Page]** Returns **[Page]**
[1]: #add [1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
[2]: #get
[3]: #getall
[4]: #getallwrappers
[5]: #getmain
[6]: #remove
[7]: #select
[8]: #getselected
[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object [2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String [3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

17
src/pages/index.ts
View File

@ -21,22 +21,7 @@
* const pageManager = editor.Pages; * const pageManager = editor.Pages;
* ``` * ```
* *
* ## Available Events * {REPLACE_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)
* * [getAllWrappers](#getallwrappers)
* * [getMain](#getmain)
* * [remove](#remove)
* * [select](#select)
* * [getSelected](#getselected)
* *
* [Page]: page.html * [Page]: page.html
* [Component]: component.html * [Component]: component.html

Write Preview
Loading…
Cancel
Save