diff --git a/docs/api/pages.md b/docs/api/pages.md index 2842b9e52..7543193f6 100644 --- a/docs/api/pages.md +++ b/docs/api/pages.md @@ -26,33 +26,39 @@ const pageManager = editor.Pages; ``` ## 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 -* `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 +```javascript +editor.on('page:add', (page) => { ... }); +``` -## Methods +* `page:remove` Page removed. The page is passed as an argument to the callback. -* [add][1] -* [get][2] -* [getAll][3] -* [getAllWrappers][4] -* [getMain][5] -* [remove][6] -* [select][7] -* [getSelected][8] +```javascript +editor.on('page:remove', (page) => { ... }); +``` -[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 @@ -64,7 +70,7 @@ Get all pages const arrayOfPages = pageManager.getAll(); ``` -Returns **[Array][10]<[Page]>** +Returns **[Array][1]<[Page]>** ## add @@ -72,8 +78,8 @@ Add new page ### Parameters -* `props` **[Object][11]** Page properties -* `opts` **[Object][11]?** Options (optional, default `{}`) +* `props` **[Object][2]** Page properties +* `opts` **[Object][2]?** Options (optional, default `{}`) ### Examples @@ -93,7 +99,7 @@ Remove page ### Parameters -* `page` **([String][12] | [Page])** Page or page id +* `page` **([String][3] | [Page])** Page or page id * `opts` **any** (optional, default `{}`) ### Examples @@ -113,7 +119,7 @@ Get page by id ### Parameters -* `id` **[String][12]** Page id +* `id` **[String][3]** Page id ### Examples @@ -147,7 +153,7 @@ const wrappers = pageManager.getAllWrappers(); const allImages = wrappers.map(wrp => wrp.findType('image')).flat(); ``` -Returns **[Array][10]<[Component]>** +Returns **[Array][1]<[Component]>** ## select @@ -155,7 +161,7 @@ Change the selected page. This will switch the page rendered in canvas ### Parameters -* `page` **([String][12] | [Page])** Page or page id +* `page` **([String][3] | [Page])** Page or page id * `opts` **SetOptions** (optional, default `{}`) ### Examples @@ -181,26 +187,8 @@ const selectedPage = pageManager.getSelected(); Returns **[Page]** -[1]: #add - -[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 +[1]: 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 diff --git a/src/pages/index.ts b/src/pages/index.ts index 1d7fc737e..ae81a182e 100644 --- a/src/pages/index.ts +++ b/src/pages/index.ts @@ -21,22 +21,7 @@ * 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) - * * [getAllWrappers](#getallwrappers) - * * [getMain](#getmain) - * * [remove](#remove) - * * [select](#select) - * * [getSelected](#getselected) + * {REPLACE_EVENTS} * * [Page]: page.html * [Component]: component.html