Skip to content

Step 4 - Creating a custom tag

The RichText Field contains some built-in elements you can use, such as an image or a table. You can also add custom tags that will enable you to add additional elements to RichText Fields.

In this step you will add a custom tag, which will enable you to create a special note box called a Factbox.

See full documentation of custom tags in Extending the Online Editor.

Configure the custom tag

First, create a file that will contain the configuration for the custom tags. Add file custom_tags.yaml to config/packages:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
ezplatform:
    system:
        admin_group:
            fieldtypes:
                ezrichtext:
                    custom_tags: [factbox]
                    toolbars:
                        ezadd:
                            buttons:
                                factbox:
                                    priority: 5
                        factbox:
                            buttons:
                                ezmoveup:
                                    priority: 40
                                ezmovedown:
                                    priority: 30
                                ezcustomtagedit:
                                    priority: 20
                                ezblockremove:
                                    priority: 10
ezrichtext:
    custom_tags:
        factbox:
            template: field_type/ezrichtext/custom_tag/factbox.html.twig
            icon: '/bundles/ezplatformadminui/img/ez-icons.svg#warning'
            attributes:
                name:
                    type: string
                    required: true
                style:
                    type: choice
                    required: true
                    default_value: light
                    choices: [light, dark]

The configuration first lists all custom tags that you have in the configuration (line 5) - in this case factbox. factbox is then configured. Line 25 points to the template used to render the tag. Then attributes of the custom tag are listed. These attributes can be set when adding the tag to a RichText Field.

Create a template

Next, create the template that is referred to in the configuration. In templates/field_type/ezrichtext/custom_tag add the following factbox.html.twig file:

1
2
3
4
5
6
<div class="ez-factbox ez-factbox--{{ params.style }}">
    <p>{{ params.name }}</p>
    <div>
        {{ content|raw }}
    </div>
</div>

Add labels

Finally, add labels to the custom tag's editing interface. Provide them in a translations/custom_tags.en.yaml file:

1
2
3
4
5
6
ezrichtext.custom_tags.factbox.label: FactBox
ezrichtext.custom_tags.factbox.description: ''
ezrichtext.custom_tags.factbox.attributes.name.label: Name
ezrichtext.custom_tags.factbox.attributes.style.label: Style
ezrichtext.custom_tags.factbox.attributes.style.choices.light.label: Light style
ezrichtext.custom_tags.factbox.attributes.style.choices.dark.label: Dark style

Check results

Tip

If you cannot see the results or encounter an error, clear the cache and reload the application.

At this point you can go to the Back Office and start editing any Content with a RichText Field (e.g. a Folder or an Article). Click Add (plus icon) on the left side of the RichText Field, and from the list of available tags select the FactBox tag icon (exclamation mark icon).

List of available tags

Provide a name and select a style.

Example of a Factbox name and style selection

You can now edit the content of the Factbox:

Example of a Factbox custom tag