Skip to content

Commit 160c017

Browse files
authored
Merge pull request #7 from magento-devdocs/MC-5769
MC-5769: Complete content type tutorial
2 parents d6cd01b + a80ff0d commit 160c017

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

docs/create-basic-content-type/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Introduction
1+
# Overview
22

33
***
44
The development of this tutorial is currently **IN PROGRESS**.
@@ -11,11 +11,11 @@ Page Builder comes with several content types (controls) you can use to build yo
1111

1212
## Quote preview
1313

14-
A preview of the Qoute content type you will build is shown in the following screenshot, which shows three instances of the Quote control, on in each column shown here on the Admin stage:
14+
The following screenshot shows three instances of the Quote control you will build in this tutorial:
1515

1616
![QuoteTypeDisplay](../images/AdminTestimonials.png)
1717

18-
And here are the same three Quote controls rendered on a mock testimonial page in the storefront:
18+
And the same three Quote controls are shown rendered here on a mock testimonial page in the storefront:
1919

2020
![StorefrontTestimonials](../images/StorefrontTestimonials.png)
2121

docs/create-basic-content-type/step-1-add-configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@ The `type` element defines the key properties of your content type. The attribut
6969
| `label` | Label displayed in the Page Builder panel, option menu, and on the Admin stage. |
7070
| `group` | Group or category in the panel menu where your content type is displayed. The default groups are Layout, Elements, Media, and Add Content. See [Panel configurations](../configurations/panel-configurations.md) for more details. |
7171
| `component` | There are two component types to choose from: `content-type` and `content-type-collection`. Use `Magento_PageBuilder/js/content-type` for static content types that do not have children. Use `Magento_PageBuilder/js/content-type-collection` for content types that can contain children, otherwise known as container content types. |
72-
| `preview_component` | Optional. JavaScript file (`preview.js`) that provides rendering logic within the Admin UI. |
73-
| `master_component` | Optional. JavaScript file (`master.js`) that provides rendering logic generic for all appearances of your content type when rendered on the storefront. |
72+
| `preview_component` | Optional. JavaScript file (`preview.js`) that provides rendering logic within the Admin UI. The preview component does not need to specify the `.js` extension. If you don't provide the `preview_component`, Page Builder uses the base `Preview` component shown in the code: `Magento_PageBuilder/js/content-type/preview`. |
73+
| `master_component` | Optional. JavaScript file (`master.js`) that provides rendering logic generic for all appearances of your content type when rendered on the storefront. The master component does not need to specify the `.js` extension. If you don't provide the `master_component`, Page Builder uses the base `Master` component shown in the code: `Magento_PageBuilder/js/content-type/master`. |
7474
| `form` | UI component form that provides the form controls for editing your content type. |
75-
| `icon` | Optional. PNG or SVG image displayed in the Page Builder panel alongside the label. |
75+
| `icon` | Optional. PNG or SVG image displayed in the Page Builder panel alongside the label. If no icon value is provided, the content type will simply be displayed in the Page Builder panel without an icon. |
7676
| `sortOrder` | Optional. The listed order within the menu group. For example, `sortOrder=21` puts the content type third in the `Elements` menu group, after the content types with `sortOrder`s of 10 and 20. |
7777
| `translate` | Identifies the attribute you want Magento to translate. Here, the `label` value is set for translation. |
7878

docs/create-basic-content-type/step-2-add-templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Conventions for adding content type templates are as follows.
1717

1818
- Page Builder requires the name of an `appearance` to match the name of the directory containing the appearance templates. If they don't match, your content type appearances will not render.
1919

20-
For example, if you navigate to the Banner's appearance templates (`app/code/Magento/PageBuilder/view/adminhtml/web/template/content-type/banner`) you can see that the names of the template directories match the names of the four appearances defined in the `banner.xml` configuration file as shown here:
20+
For example, if you navigate to the Banner's appearance templates (`PageBuilder/view/adminhtml/web/template/content-type/banner`) you can see that the names of the template directories match the names of the four appearances defined in the `banner.xml` configuration file as shown here:
2121

2222
```xml
2323
<appearances>

docs/images/content-type-files.png

68 Bytes
Loading

0 commit comments

Comments
 (0)