You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/create-custom-content-type/step-1-add-configuration.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -63,9 +63,9 @@ The `type` element defines the key properties of your content type. The attribut
63
63
|`name`| Name of the content type that Magento uses for XML merging. The convention for using multi-word names is to separate the words with hyphens. |
64
64
|`label`| Label displayed in the Page Builder panel, option menu, and on the Admin stage. |
65
65
|`menu_section`| Menu section or category in the panel menu where your content type is displayed. The default menu sections are Layout, Elements, Media, and Add Content. See [Panel configurations](../how-to/how-to-customize-panel.md) for more details. |
66
-
|`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. |
67
-
|`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`. |
68
-
|`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`. |
66
+
|`component`|View model responsible for rendering the preview and master format. 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. |
67
+
|`preview_component`| JavaScript file (`preview.js` or `preview-collection.js`) that provides rendering logic within the Admin UI. The preview component does not need to specify the `.js` extension. <br />For _collection_ content types, you need to either reference your own `preview-collection` component or reference Page Builder's `preview-collection` (``preview_component="Magento_PageBuilder/js/content-type/preview-collection"`). If you don't specify the `preview_component`, Page Builder uses the base `Preview` component shown in the code: `Magento_PageBuilder/js/content-type/preview`. |
68
+
|`master_component`| JavaScript file (`master.js` or `master-collection.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. <br />For _collection_ content types, you need to either reference your own `master-collection` component or reference Page Builder's `master-collection` (`master_component="Magento_PageBuilder/js/content-type/master-collection"`). If you don't specify the `master_component`, Page Builder uses the base `Master` component shown in the code: `Magento_PageBuilder/js/content-type/master`. |
69
69
|`form`| UI component form that provides the form controls for editing your content type. |
70
70
|`icon`| Optional. Class name for your PNG or SVG image (or font icon) displayed in the Page Builder panel alongside the label. If you don't provide an icon value, the Page Builder panel displays the content type name without an icon. |
71
71
|`sortOrder`| Optional. The listed order within the menu section. For example, `sortOrder=21` puts the content type third in the `Elements` menu section, after the content types with `sortOrder` values of 10 and 20. |
|`name`|Describes the content types internal name, this is used to when the system references the content type. |
18
-
|`label`| Label displayed within the menu and stage. |
19
-
|`menu_section`|Allocate the content type to a menu section, the menu section must exist and be defined in `menu_section.xml`. |
17
+
|`name`|Name of the content type that Magento uses for XML merging. The convention for using multi-word names is to separate the words with hyphens. |
18
+
|`label`| Label displayed in the Page Builder panel, option menu, and on the Admin stage. |
19
+
|`menu_section`|Menu section or category in the panel menu where your content type is displayed. The default menu sections are Layout, Elements, Media, and Add Content. See [Panel configurations](../how-to/how-to-customize-panel.md) for more details.|
20
20
|`icon`| CSS class for icon to be displayed within the menu alongside the content types name. See [How to add icons and images](../how-to/how-to-add-icons-images.md) for more guidance. |
21
-
|`component`| View model responsible for rendering the preview and master format. |
22
-
|`preview_component`|Helper component that contains preview specific logic. Helper component is optional. |
23
-
|`master_component`|Contains master format rendering logic that is generic for all appearances. Content component is optional. |
24
-
|`form`| UI component form used for editing the content type. |
21
+
|`component`| View model responsible for rendering the preview and master format. 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.|
22
+
|`preview_component`|JavaScript file (`preview.js` or `preview-collection.js`) that provides rendering logic within the Admin UI. The preview component does not need to specify the `.js` extension. <br />For _collection_ content types, you need to either reference your own `preview-collection` component or reference Page Builder's `preview-collection` (``preview_component="Magento_PageBuilder/js/content-type/preview-collection"`). If you don't specify the `preview_component`, Page Builder uses the base `Preview` component shown in the code: `Magento_PageBuilder/js/content-type/preview`. |
23
+
|`master_component`|JavaScript file (`master.js` or `master-collection.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. <br />For _collection_ content types, you need to either reference your own `master-collection` component or reference Page Builder's `master-collection` (`master_component="Magento_PageBuilder/js/content-type/master-collection"`). If you don't specify the `master_component`, Page Builder uses the base `Master` component shown in the code: `Magento_PageBuilder/js/content-type/master`. |
24
+
|`form`| UI component form that provides the form controls for editing your content type.|
25
25
{:style="table-layout:auto"}
26
26
27
27
#### Basic Configuration Example
@@ -46,7 +46,7 @@ There are a number of child elements which can be configured, these are typicall
46
46
|`parents`| Defines the default policy and matrix of which content types this content type can have as a parent. For instance the Slide content type defines a default policy of `deny` with an exception allowing this content type to only be housed within the Slider content type. |
47
47
|`children`| Similar to the `parents` option, however this defines the allowed `children` of the current content type. As with the Slide example this time the Slider defines the Slide as it's only allowed child. |
48
48
|`appearances`| Configures various appearances along with associated data mapping elements. This is a crucial part of all content types and defines how the master and preview systems should retrieve and display their data. |
49
-
|`is_system`| Determines menu visibility for the component. System components are not be visible in the menu. The default value for this is true. We use this to hide child or "special" content types that are added by other content types. For instance the Slide is not able to be dragged into the stage itself, thus it's not a system content type. |
49
+
|`is_system`| Determines menu visibility for the component. System components are visible in the menu. The default value for this is true. By setting this to false, you can hide child or "special" content types that are added by other content types. For examples, the Slide is not able to be dragged onto the stage itself, thus it is not a system content type. |
50
50
|`additional_data`| Allows you to specify additional data for the component. See [additional configurations](../how-to/how-to-add-additional-configurations.md) for more information. |
0 commit comments