Skip to main content

Custom Bricks

If you want to have full control about your area brick, create a default brick. If you just want to create a simple brick, create a simple brick. With simple bricks you don't have to create any php classes at all but.

Default Brick​

There are three simple steps to create a custom brick:

  1. Add this configuration to /config/packages/toolbox.yaml:
services:
    App\Document\Areabrick\MyBrick\MyBrick:
        parent: OpenDxp\Bundle\ToolboxBundle\Document\Areabrick\AbstractAreabrick
        tags:
            - { name: toolbox.area.brick, id: my_brick }

opendxp_toolbox:
    areas:
        # that's the name of your brick. 
        my_brick:
            config_elements:
                title1:
                    type: input
                    title: That's a Title
                    description: Lorem Ipsum
                    # default config for input
                    # see: https://docs.opendxp.io/docs/core-framework/Documents/Editables/Input#configuration
                    config: ~
                title2:
                    type: input
                    title: That's also a Title
                    description: Lorem Ipsum
                    config: ~
  1. Add the area class to App/Document/Areabrick/MyBrick/MyBrick.php:
<?php

namespace App\Document\Areabrick\MyBrick;

use OpenDxp\Model\Document\Editable\Area\Info;use Symfony\Component\HttpFoundation\Response;use OpenDxp\Bundle\ToolboxBundle\Document\Areabrick\AbstractAreabrick;

class MyBrick extends AbstractAreabrick
{
    public function action(Info $info): ?Response
    {
        //call this to activate all the toolbox magic.
        return parent::action($info);
    }

    public function getTemplateDirectoryName():string
    {
        // this method is only required if your brick name (e.g. my_brick or myBrick)
        // differs from the view template name (e.g. my-brick)
        
        return 'my-brick';
    }

    public function getTemplate(): string
    {
        // this method is only required if your brick name (e.g. my_brick or myBrick)
        // differs from the view template name (e.g. my-brick)
        
        return sprintf('areas/%s/view.%s', $this->getTemplateDirectoryName(), $this->getTemplateSuffix());
    }

    public function getName():string
    {
        return 'My Brick';
    }

    public function getDescription():string
    {
        return 'My Brick';
    }

    public function getIcon():string
    {
        return '/static/areas/my-brick/icon.svg';
    }
}
  1. Add the view to /templates/areas/my-brick/view.html.twig:
<div class="my-brick {{ additionalClassesData|join(' ') }}">
    <h3>{{ opendxp_input('title1').data }}</h3>
    <p>{{ opendxp_input('title2').data }}</p>
</div>

That's it. If you want to refresh the permission table you also need to execute the bin/console cache:clear command.

Simple Brick​

Two steps to create a simple brick:

  1. Add this configuration to /config/packages/toolbox.yaml:
services:

    # this is the fastest way to create a simple brick. 
    # template needs to be located in /template/areas/my_simple_brick/view.html.twig
    app.brick.my_simple_brick: 
        parent: OpenDxp\Bundle\ToolboxBundle\Document\Areabrick\AbstractAreabrick
        tags:
            - {  name: toolbox.area.simple_brick, id: my_simple_brick, title: 'My Simple Brick' }
              
    # OR, you may want to define some more info: description, template path and icon 
    app.brick.my_second_simple_brick:
        parent: OpenDxp\Bundle\ToolboxBundle\Document\Areabrick\AbstractAreabrick
        tags:
            - {
                name: toolbox.area.simple_brick,
                id: my_scond_simple_brick,
                title: 'My Second Simple Brick',
                description: 'Some Description',
                template: 'areas/my-second-simple-brick/view.html.twig',
                icon: '/public/path/to/your/icon.svg'
            } 
                
opendxp_toolbox:
    areas:
        # that's the name of your simple brick. 
        # configuration behaves the same as a default brick 
        my_simple_brick:
            config_elements:
                title:
                    type: input
                    title: That's a Title
                    description: Lorem Ipsum
                    config: ~
  1. Add the view to /templates/areas/my_simple_brick/view.html.twig:
<div class="my-brick {{ additionalClassesData|join(' ') }}">
    <span>{{ opendxp_input('title').data }}</span>
</div>

That's it. If you want to refresh the permission table you also need to execute the bin/console cache:clear command.

Bricks without Editables (No Config Dialog)​

Sometimes you need a real simple area brick without any configuration for editors. To do so, you only need to change the parent class:

services:
    # for default bricks
    App\Document\Areabrick\MyBrick\MyBrick:
        parent: OpenDxp\Bundle\ToolboxBundle\Document\Areabrick\AbstractBaseAreabrick
        tags:
            - { name: toolbox.area.brick, id: my_brick_without_configurable_options }

    # for simple bricks
    app.brick.my_simple_brick_without_configurable_options: 
        parent: OpenDxp\Bundle\ToolboxBundle\Document\Areabrick\AbstractBaseAreabrick
        tags:
            - { name: toolbox.area.simple_brick, id: my_simple_brick_without_configurable_options, title: 'My Simple Brick (Without configurable Options)' }

Tabbed Config Dialog​

image

To use tabs in your config dialog, you have to define them via the tab config node:

opendxp_toolbox:
    areas:
        dummy_brick:
            tabs:              # <-- define tabs here first!
                tab1: 'Tab 1'
                tab2: 'Tab 2'
            config_elements:
                title1:
                    type: input
                    title: That's Title I
                    description: Lorem Ipsum
                    tab: tab1  # <-- add to tab1
                    config: ~
                title2:
                    type: input
                    title: That's Title II
                    description: Lorem Ipsum
                    tab: tab1  # <-- add to tab1
                    config: ~
                title3:
                    type: input
                    title: That's Titel III
                    description: Lorem Ipsum
                    tab: tab2   # <-- add to tab2
                    config: ~