Skip to content

Commit e6c221f

Browse files
author
Igor Melnikov
committed
MAGETWO-91200: Update documentation for PageBuilder EAP
- update documentation
1 parent d70ef70 commit e6c221f

File tree

4 files changed

+49
-61
lines changed

4 files changed

+49
-61
lines changed

app/code/Magento/PageBuilder/docs/content-type-configuration.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Content Type Configuration
22

3+
**Note:**
4+
*We are revising configuration, format may change.*
5+
36
## Navigation
47

58
1. [Introduction]

app/code/Magento/PageBuilder/docs/events.md

Lines changed: 19 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ This document describes events dispatched in PageBuilder and parameters.
4242
* [slider:block:ready](#sliderblockready)
4343
* [stage:error](#stageerror)
4444
* [stage:ready:{{id}}](#stagereadyid)
45-
* [stage:renderTrree:{{id}}](#stagerendertrreeid)
45+
* [stage:renderTree:{{id}}](#stagerendertreeid)
4646
* [stage:updated](#stageupdated)
4747
* [state](#state)
4848
* [tab-item:block:duplicate](#tab-itemblockduplicate)
@@ -268,7 +268,7 @@ This document describes events dispatched in PageBuilder and parameters.
268268

269269
``` js
270270
{
271-
column: ContentTypeInterface;
271+
column: Column;
272272
stageId: string;
273273
}
274274
```
@@ -284,9 +284,9 @@ This document describes events dispatched in PageBuilder and parameters.
284284

285285
``` js
286286
{
287-
column,
287+
column: Column,
288288
handle,
289-
parent
289+
parent: ColumnGroup
290290
}
291291
```
292292

@@ -302,8 +302,8 @@ This document describes events dispatched in PageBuilder and parameters.
302302

303303
``` js
304304
{
305-
column,
306-
stageId
305+
column: Column,
306+
stageId: string
307307
}
308308
```
309309

@@ -319,9 +319,9 @@ This document describes events dispatched in PageBuilder and parameters.
319319

320320
``` js
321321
{
322-
column,
322+
column: Column,
323323
element,
324-
parent
324+
parent: ColumnGroup
325325
}
326326
```
327327

@@ -405,8 +405,7 @@ This document describes events dispatched in PageBuilder and parameters.
405405

406406
**Params**
407407

408-
``` js
409-
```
408+
object
410409

411410
## `image:block:ready`
412411

@@ -416,8 +415,7 @@ This document describes events dispatched in PageBuilder and parameters.
416415

417416
**Params**
418417

419-
``` js
420-
```
418+
Function
421419

422420
[Back to top]
423421

@@ -429,11 +427,7 @@ This document describes events dispatched in PageBuilder and parameters.
429427

430428
**Params**
431429

432-
``` js
433-
{
434-
callback: (files: object [ ] ) => any
435-
}
436-
```
430+
Function
437431

438432
[Back to top]
439433

@@ -543,7 +537,6 @@ This document describes events dispatched in PageBuilder and parameters.
543537
**Triggers**
544538

545539
* `ContentTypeFactory::fireBlockReadyEvent`
546-
* `ContentTypeMountEventParamsInterface`
547540

548541
**Params**
549542

@@ -561,7 +554,6 @@ This document describes events dispatched in PageBuilder and parameters.
561554
**Triggers**
562555

563556
* `ContentTypeFactory::createContentType`
564-
* `ContentTypeCreateEventParamsInterface`
565557

566558
**Params**
567559

@@ -577,7 +569,6 @@ This document describes events dispatched in PageBuilder and parameters.
577569
**Triggers**
578570

579571
* `Stage::onBlockDropped`
580-
* `ContentTypeReadyEventParamsInterface`
581572

582573
**Params**
583574

@@ -615,7 +606,6 @@ This document describes events dispatched in PageBuilder and parameters.
615606

616607
* `ContentTypeCollection::addChild`
617608
* `Column.Preview::fireMountEvent`
618-
* `ContentTypeMountEventParamsInterface`
619609

620610
**Params**
621611

@@ -652,7 +642,6 @@ This document describes events dispatched in PageBuilder and parameters.
652642
**Triggers**
653643

654644
* `ContentTypeFactory::fireBlockReadyEvent`
655-
* `ContentTypeReadyEventParamsInterface`
656645

657646
**Params**
658647

@@ -673,8 +662,7 @@ This document describes events dispatched in PageBuilder and parameters.
673662

674663
**Params**
675664

676-
``` js
677-
```
665+
Error
678666

679667
[Back to top]
680668

@@ -685,7 +673,7 @@ This document describes events dispatched in PageBuilder and parameters.
685673
* `Stage::ready`
686674
* `stage instance`
687675

688-
## `stage:renderTrree:{{id}}`
676+
## `stage:renderTree:{{id}}`
689677

690678
**Triggers**
691679

@@ -695,7 +683,7 @@ This document describes events dispatched in PageBuilder and parameters.
695683

696684
``` js
697685
{
698-
value
686+
value: string
699687
}
700688
```
701689

@@ -712,7 +700,7 @@ This document describes events dispatched in PageBuilder and parameters.
712700

713701
``` js
714702
{
715-
stageId
703+
stageId: number
716704
}
717705
```
718706

@@ -728,7 +716,7 @@ This document describes events dispatched in PageBuilder and parameters.
728716

729717
``` js
730718
{
731-
state
719+
state: DataObject
732720
}
733721
```
734722

@@ -745,9 +733,9 @@ This document describes events dispatched in PageBuilder and parameters.
745733

746734
``` js
747735
{
748-
original: originalBlock,
749-
duplicateBlock,
750-
index,
736+
original: ContentTypeInterface,
737+
duplicateBlock: ContentTypeInterface,
738+
index: number,
751739
}
752740
```
753741

@@ -759,7 +747,6 @@ This document describes events dispatched in PageBuilder and parameters.
759747

760748
* `ContentTypeCollection::addChild`
761749
* `Column.Preview::fireMountEvent`
762-
* `ContentTypeMountEventParamsInterface`
763750

764751
**Params**
765752

@@ -797,7 +784,6 @@ This document describes events dispatched in PageBuilder and parameters.
797784
**Triggers**
798785

799786
* `Stage::onBlockDropped`
800-
* `ContentTypeReadyEventParamsInterface`
801787

802788
**Params**
803789

@@ -815,7 +801,6 @@ This document describes events dispatched in PageBuilder and parameters.
815801
**Triggers**
816802

817803
* `ContentTypeFactory::fireBlockReadyEvent`
818-
* `ContentTypeReadyEventParamsInterface`
819804

820805
**Params**
821806

-1.23 KB
Loading

0 commit comments

Comments
 (0)