Skip to content

Commit 5f36d5b

Browse files
committed
MC-4181: Organize Existing Topics
Added screenshots and better explanations as suggested in PR review
1 parent a368c69 commit 5f36d5b

File tree

6 files changed

+16
-9
lines changed

6 files changed

+16
-9
lines changed

docs/customizations/product-conditions.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,20 @@
44

55
## What's in this topic
66

7-
This topic describes how to use the product conditions rule tree for different content types. By reusing the conditions mechanism you can apply it to your own custom content types.
7+
Out-of-the-box, product conditions can be set on Page Builder's Product content type to define which products you want to display based on a variety of product attributes. For example, if you only want display products in a category with a price greater than $50, you would setup a condition for the product as shown here:
8+
9+
![product conditions](../images/product-conditions.png "Product conditions example")
10+
11+
This topic describes how you can apply the conditions mechanism to your own custom content types.
812

913
## Overview
1014

1115
To reuse conditions for custom content types:
1216

1317
1. [Add an attribute to the content type](#add-attribute)
14-
2. [Add the conditions form element to the `form` UI component](#add-conditions)
18+
2. [Add the conditions](#add-conditions)
1519
3. [Create a custom `form` data provider](#data-provider)
16-
4. [Include the `conditionsDataProcessor` and attribute in the data provider](#include)
20+
4. [Include the `conditionsDataProcessor` and attribute](#include)
1721

1822
## Add an attribute to the content type {#add-attribute}
1923

@@ -23,7 +27,7 @@ To add an attribute within your custom content type:
2327
<attribute source="data-myconditions" name="myconditions"/>
2428
```
2529

26-
## Add the conditions form element to the `form` UI component {#add-conditions}
30+
## Add the conditions {#add-conditions}
2731

2832
To add the conditions `form` element to the `form` UI component:
2933

@@ -60,7 +64,7 @@ To create a custom `form` data provider for the edit form:
6064

6165
The preceding code is an example of how to add a custom `form` data provider. Replace values with ones specific to your custom content type and component.
6266

63-
## Include the `conditionsDataProcessor` and attribute in the data provider {#include}
67+
## Include the `conditionsDataProcessor` and attribute {#include}
6468

6569
To include the `conditionsDataProcessor` and accompanying attribute in the data provider file, `view/adminhtml/web/js/content-type/mycomponent/form/provider.js`:
6670

docs/customizations/visual-selects.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66

77
This topic describes how to extend some Page Builder fields to accommodate a custom look and feel for the text alignment option.
88

9-
The text alignment field for each content block, in the Advanced section, now shows an icon and title. You can customize the text alignment field to show this new look and feel for all content blocks.
9+
In the Advanced section of the content editor, the text alignment field for each content type now shows an icon and title. You can customize the text alignment field to show this new look and feel for your custom content types.
10+
11+
![alignments](../images/advanced-alignment.png "Content alignment")
1012

1113
All image formats are supported for icons, though we suggest using an SVG format.
1214

@@ -20,7 +22,7 @@ To add Visual Select customization to a Page Builder content block:
2022

2123
## Override the select component with an element template {#element-template}
2224

23-
We use the default select component in the `/app/code/Magento/PageBuilder/view/adminhtml/ui-component/pagebuilder_base_form.xml` file. You can override the default template, specifying an element template & component for this functionality, to implement the Visual Select option.
25+
We use the default select component in the `/app/code/Magento/PageBuilder/view/adminhtml/ui-component/pagebuilder_base_form.xml` file. You can override the default template, by specifying an element template and component for this functionality to implement the Visual Select option.
2426

2527
In the provided template, specify `<elementTmpl>` alongside updating the fields component to `Magento_PageBuilder/js/form/element/visual-select`:
2628

@@ -35,7 +37,7 @@ In the provided template, specify `<elementTmpl>` alongside updating the fields
3537

3638
## Add Visual Select to the XML config {#xml-config}
3739

38-
The available options for select, `value`, `title`, `icon` and `noticeMessage`, can be provided by the PHP class that implements the `\Magento\Framework\Option\ArrayInterface` method.
40+
The available options for select, `value`, `title`, `icon` and `noticeMessage`, can be provided by the PHP class that implements the `\Magento\Framework\Option\ArrayInterface` method.
3941

4042
Options should return an array with the following format:
4143

@@ -123,7 +125,7 @@ To apply vertical alignment to a content type using the Visual Select component,
123125
</virtualType>
124126
```
125127

126-
### Add the Visual Select option in your module's form configuration file.
128+
### Add the Visual Select option in your module's form configuration file
127129

128130
```xml
129131
<field name="justify_content" sortOrder="20" formElement="select" component="Magento_PageBuilder/js/form/element/visual-select">

docs/getting-started/activate-pagebuilder.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Follow these steps to activate PageBuilder in the Admin:
1010
2. In the **Stores** tab, select **Configuration** under the Settings group.
1111
3. In the **General** group on the page, select **Content Management**.
1212
4. Under **Advanced Content Tools**, select **Yes** for **Enable Page Builder**.
13+
![activate page builder](../images/activate-pagebuilder.png "Activate Page Builder")
1314
5. Click **Save Config**
1415

1516
## Deactivate Page Builder

docs/images/activate-pagebuilder.png

123 KB
Loading

docs/images/advanced-alignment.png

7.81 KB
Loading

docs/images/product-conditions.png

25 KB
Loading

0 commit comments

Comments
 (0)