Custom Fields
- Tomasz Drabik
- Krzysztof Kula
- Marta Siewierska-Stańczak
It is possible to add custom fields to the Content Constructor components per project to all Content Constructor components. This feature allows adding new configuration fields, which can be saved in Component configuration and read later within the templates to develop custom functionalities.
There are many types of fields that are supported. They will be listed and described in detail at the end of this document.
How to introduce custom fields
The mechanism relies on adding new configurator fields by extending view.xml variables for MageSuite_ContentConstructor module in the project theme.
There are two places, for which, custom fields can be added:
Image Teaser Slide Configurator - a place where we configure a specific image within the Image Teaser
Component Configurator - general configurator of the component
The rest happens under the hood of content constructor module.
The easiest way to see it in action is to try yourself, just use the below examples to add custom fields,
and use configurations of their types form the table
Please pay attention to the frontend_type entry in the custom field configuration.
This entry is used to tell the frontend part of a component, if this is html or a css_class. Default value is html. If you specify this as css_class, then the chosen value will be automatically added to the class list of the component’s container. No need to do anything else. Script automatically finds all custom fields with this type, collects them and adds to the additional classes property.
You can use this in custom fields for whole component as well as image teaser slide.
Adding custom field to Component Configurator
Example Task: My designs say that the image teaser component can have either white (default), grey or black background. A client wants to decide on that while configuring component.
// theme-example/src/etc/view.xml
<vars module="MageSuite_ContentConstructor">
<var name="image_teaser">
<var name="custom_sections">
<var name="0">
<var name="label">Advanced</var>
<var name="content">
<var name="fields">
<var name="0">
<var name="label">Component's container background color</var>
<var name="type">select</var>
<var name="model">background</var>
<var name="options">
<var name="cs-container--bg-white">White</var>
<var name="cs-container--bg-grey">Grey</var>
<var name="cs-container--bg-black">Black</var>
</var>
<var name="default">cs-container--bg-white</var>
<var name="frontend_type">css_class</var>
</var>
</var>
</var>
</var>
</var>
</var>
</vars>Adding a custom field to the Image Teaser slide configurator
Example task: Client needs to display price of the product, he puts into image teaser and additionally he wants to select its position among 9 predefined, exactly the way text content is positioned.
For this purpose 2 custom fields will be added to Image Teaser slide configurator:
<vars module="MageSuite_ContentConstructor">
<var name="teaser">
<var name="tabs">
<var name="3">
<var name="label">badge</var>
<var name="content">
<var name="fields">
<var name="0">
<var name="label">Badge text</var>
<var name="type">textarea</var>
<var name="model">badge_text</var>
<var name="hint"><![CDATA[
Add content with special markup, e.g.:<br>
- <small>Only</small> {{price sku="some_sku"}}<br>
- {{sku sku="some_sku"}}<br>
- <big>Only</big> {{qty sku="some_sku"}} left
]]></var>
</var>
<var name="1">
<var name="label">Badge align</var>
<var name="type">position</var>
<var name="model">badge_align</var>
<var name="rows">3</var>
<var name="columns">3</var>
<var name="default">
<var name="x">1</var>
<var name="y">1</var>
</var>
<var name="warning">Note: Please verify text position configuration in the "Content" tab. It might overlap the badge position.</var>
</var>
</var>
</var>
</var>
</var>
</var>
</vars>Types of custom fields
Below table contains a list of all types of fields, that can be used:
Field type | Description | Vars available | Markup example | Effect |
|---|---|---|---|---|
input | Text type input. Dedicated for providing custom CSS classes or short content |
| // theme-myproject/src/etc/view.xml
...
<var name="fields">
<var name="1">
<var name="label">Text input</var>
<var name="type">input</var>
<var name="model">input_sample</var>
<var name="hint">Hey, this is example of "hint"</var>
<var name="default">Default input value</var>
<var name="frontend_type">css_class</var>
</var>
</var>
...
... | |
select | Select field. Dedicated for limited options, like pre-defined CSS classes or icons | Same as for "input". The only difference is that value of default has to cover one of defined options | ||
multiselect | Mulstiselect field, that allows selecting multiple options. | Extends select vars. The difference is that default options contain array of default entries, with the value that stands for option “name”. |
| |
textarea | Textarea for more complex content. Remember to not provide too much of it as frontend might have problems to fit all of it. You can use directives. | Same as for "input" | ||
position | Position grid feature known from Content Align feature to set position of text for single teaser |
| ||
checkbox | checkbox styled magento way (switcher-alike). Use it if you need boolean value on the frontend |
| ||
radio | Standard options list | Same as for "select" | ||
color | Color value with picker |
|
| |
datetime-range | Date time range picker, that consists of two inputs with type “datetime-local” |
|
|