Skip to content

Commit 6a9ef47

Browse files
bdenhambdenham
committed
MAGEDOC-3440: Edit events topic
Changed event examples to account for breaking changes
1 parent d1edebe commit 6a9ef47

File tree

1 file changed

+34
-30
lines changed

1 file changed

+34
-30
lines changed

‎docs/reference/events.md

Lines changed: 34 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ The following table lists the Page Builder events you can bind to and handle wit
2929
| [contentType:duplicateAfter](#contenttypeduplicateafter) | [stage:interactionStart](#stageinteractionstart) |
3030
| [contentType:mountAfter](#contenttypemountafter) | [stage:interactionStop](#stageinteractionstop) |
3131
| [contentType:moveAfter](#contenttypemoveafter) | [stage:error](#stageerror) |
32-
| [contentType:moveBefore](#contenttypemovebefore) | [stage:{{preview.parent.stageId}}:masterFormatRenderAfter](#stageidmasterformatrenderafter) |
33-
| [contentType:redrawAfter](#contenttyperedrawafter) | [stage:{{preview.parent.stageId}}:readyAfter](#stageidreadyafter) |
34-
| [contentType:removeAfter](#contenttyperemoveafter) | [stage:{{preview.parent.stageId}}:renderAfter](#stagepreviewparentstageidrenderafter) |
35-
| [contentType:renderAfter](#contenttyperenderafter) | [stage:{{preview.parent.stageId}}:toggleFullscreen](#stageidtogglefullscreen) |
32+
| [contentType:moveBefore](#contenttypemovebefore) | [stage:{{preview.contentType.stageId}}:masterFormatRenderAfter](#stageidmasterformatrenderafter) |
33+
| [contentType:redrawAfter](#contenttyperedrawafter) | [stage:{{preview.contentType.stageId}}:readyAfter](#stageidreadyafter) |
34+
| [contentType:removeAfter](#contenttyperemoveafter) | [stage:{{preview.contentType.stageId}}:renderAfter](#stagepreviewcontenttypestageidrenderafter) |
35+
| [contentType:renderAfter](#contenttyperenderafter) | [stage:{{preview.contentType.stageId}}:toggleFullscreen](#stageidtogglefullscreen) |
3636
| | [stage:updateAfter](#stageupdateafter) |
3737
| | |
3838
| **Column Events** | **Preview Events** |
@@ -41,9 +41,9 @@ The following table lists the Page Builder events you can bind to and handle wit
4141
| [column:initializeAfter](#columninitializeafter) | [previewData:updateAfter](#previewdataupdateafter) |
4242
| | |
4343
| **Image Events** | **Other Events** |
44-
| [image:{{preview.parent.id}}:assignAfter](#imageidassignafter) | [googleMaps:authFailure](#googlemapsauthfailure) |
44+
| [image:{{preview.contentType.id}}:assignAfter](#imageidassignafter) | [googleMaps:authFailure](#googlemapsauthfailure) |
4545
| [image:mountAfter](#imagemountafter) | [state](#state) |
46-
| [image:uploadAfter](#imageuploadafter) | [{{config.name}}:{{preview.parent.id}}:updateAfter](#confignameidupdateafter) |
46+
| [image:uploadAfter](#imageuploadafter) | [{{config.name}}:{{preview.contentType.id}}:updateAfter](#confignameidupdateafter) |
4747
| | |
4848

4949
## Event details
@@ -71,7 +71,9 @@ events.on("contentType:createAfter", function (params) {});
7171

7272

7373

74-
### `contentType:mountAfter` (ContentType)
74+
### `contentType:mountAfter`
75+
76+
#### ContentType
7577

7678
```js
7779
events.on("contentType:mountAfter", function (params) {});
@@ -86,7 +88,9 @@ events.on("contentType:mountAfter", function (params) {});
8688

8789

8890

89-
### `contentType:mountAfter` (ContentTypeCollection)
91+
### `contentType:mountAfter`
92+
93+
#### ContentTypeCollection
9094

9195
```js
9296
events.on("contentType:mountAfter", function (params) {});
@@ -143,7 +147,7 @@ events.on("contentType:removeAfter", function (params) {});
143147
| ------------- | ---------------------------------------------- |
144148
| `contentType` | `ContentType`: `ContentTypeInterface` |
145149
| `index` | `number` |
146-
| `parent` | `ContentType`:`ContentTypeCollectionInterface` |
150+
| `contentType` | `ContentType`:`ContentTypeCollectionInterface` |
147151
| `stageId` | `string` |
148152

149153
[Back to top]
@@ -176,8 +180,8 @@ events.on("contentType:moveBefore", function (params) {});
176180
| Params | Type |
177181
| -------------- | ----------------------------------------------------------- |
178182
| `contentType` | `ContentTypeInterface` and `ContentTypeCollectionInterface` |
179-
| `sourceParent` | `ContentTypeCollectionInterface` |
180-
| `targetParent` | `ContentTypeCollectionInterface` |
183+
| `sourceContentType` | `ContentTypeCollectionInterface` |
184+
| `targetContentType` | `ContentTypeCollectionInterface` |
181185
| `targetIndex` | `number` |
182186
| `stageId` | `string` |
183187

@@ -194,8 +198,8 @@ events.on("contentType:moveAfter", function (params) {});
194198
| Params | Type |
195199
| -------------- | ----------------------------------------------------------- |
196200
| `contentType` | `ContentTypeInterface` and `ContentTypeCollectionInterface` |
197-
| `sourceParent` | `ContentTypeCollectionInterface` |
198-
| `targetParent` | `ContentTypeCollectionInterface` |
201+
| `sourceContentType` | `ContentTypeCollectionInterface` |
202+
| `targetContentType` | `ContentTypeCollectionInterface` |
199203
| `targetIndex` | `number` |
200204
| `stageId` | `string` |
201205

@@ -266,16 +270,16 @@ events.on("column:initializeAfter", function (params) {});
266270
| --------- | ------------- |
267271
| `column` | `Column` |
268272
| `element` | `Element` |
269-
| `parent` | `ColumnGroup` |
273+
| `contentType` | `ColumnGroup` |
270274

271275
[Back to top]
272276

273277

274278

275-
### `image:{{preview.parent.id}}:assignAfter` {#imageidassignafter}
279+
### `image:{{preview.contentType.id}}:assignAfter` {#imageidassignafter}
276280

277281
```js
278-
events.on(`image:${this.parent.id}:assignAfter`, function (params) {});
282+
events.on(`image:${this.contentType.id}:assignAfter`, function (params) {});
279283
```
280284

281285

@@ -316,10 +320,10 @@ events.on("image:uploadAfter", function (params) {});
316320

317321

318322

319-
### `stage:{{preview.parent.stageId}}:readyAfter`
323+
### `stage:{{preview.contentType.stageId}}:readyAfter`
320324

321325
```js
322-
events.on(`stage:${this.parent.stageId}:readyAfter`, function (params) {});
326+
events.on(`stage:${this.contentType.stageId}:readyAfter`, function (params) {});
323327
```
324328

325329
| Params | Type |
@@ -330,10 +334,10 @@ events.on(`stage:${this.parent.stageId}:readyAfter`, function (params) {});
330334

331335

332336

333-
### `stage:{{preview.parent.stageId}}:renderAfter`
337+
### `stage:{{preview.contentType.stageId}}:renderAfter`
334338

335339
```js
336-
events.on(`stage:${this.parent.stageId}:renderAfter`, function (params) {});
340+
events.on(`stage:${this.contentType.stageId}:renderAfter`, function (params) {});
337341
```
338342

339343
| Params | Type |
@@ -372,10 +376,10 @@ events.on("stage:interactionStop", function () {});
372376

373377

374378

375-
### `stage:{{preview.parent.stageId}}:toggleFullscreen` {#stageidtogglefullscreen}
379+
### `stage:{{preview.contentType.stageId}}:toggleFullscreen` {#stageidtogglefullscreen}
376380

377381
```js
378-
events.on(`stage:${this.parent.stageId}:toggleFullscreen`, function (params) {});
382+
events.on(`stage:${this.contentType.stageId}:toggleFullscreen`, function (params) {});
379383
```
380384

381385
| Params | Type |
@@ -448,10 +452,10 @@ events.on("stage:error", function (params) {});
448452

449453

450454

451-
### `stage:{{preview.parent.stageId}}:readyAfter` {#stageidreadyafter}
455+
### `stage:{{preview.contentType.stageId}}:readyAfter` {#stageidreadyafter}
452456

453457
```js
454-
events.on(`stage:${this.parent.stageId}:readyAfter`, function (params) {});
458+
events.on(`stage:${this.contentType.stageId}:readyAfter`, function (params) {});
455459
```
456460

457461
| Params | Type |
@@ -460,13 +464,13 @@ events.on(`stage:${this.parent.stageId}:readyAfter`, function (params) {});
460464

461465
[Back to top]
462466

463-
### `stage:{{preview.parent.stageId}}:readyAfter` {#stageidreadyafter}
467+
### `stage:{{preview.contentType.stageId}}:readyAfter` {#stageidreadyafter}
464468

465469

466-
### `stage:{{preview.parent.stageId}}:masterFormatRenderAfter` {#stageidmasterformatrenderafter}
470+
### `stage:{{preview.contentType.stageId}}:masterFormatRenderAfter` {#stageidmasterformatrenderafter}
467471

468472
```js
469-
events.on(`stage:${this.parent.stageId}:masterFormatRenderAfter`, function (params) {});
473+
events.on(`stage:${this.contentType.stageId}:masterFormatRenderAfter`, function (params) {});
470474
```
471475

472476
| Params | Type |
@@ -529,14 +533,14 @@ events.on("state", function (params) {});
529533
| ------- | ----------- |
530534
| `state` | `DataStore` |
531535

532-
### `{{config.name}}:{{preview.parent.id}}:updateAfter` {#confignameidupdateafter}
536+
### `{{config.name}}:{{preview.contentType.id}}:updateAfter` {#confignameidupdateafter}
533537

534538

535539

536-
### `{{config.name}}:{{preview.parent.id}}:updateAfter` {#confignameidupdateafter}
540+
### `{{config.name}}:{{preview.contentType.id}}:updateAfter` {#confignameidupdateafter}
537541

538542
```js
539-
events.on(`${this.config.name}:${this.parent.id}:updateAfter`, function (params) {});
543+
events.on(`${this.config.name}:${this.contentType.id}:updateAfter`, function (params) {});
540544
```
541545

542546
| Params | Type |

0 commit comments

Comments
 (0)