0_Usage.md

Usage

Some important advices if you're going to use this bundle in your project.

Area Brick

The Toolbox Bundle will help you to display area bricks with some nice additions.

Area Brick Configuration

Important! Make sure that every pimcore_areablock in your project implements the toolbox_areablock_config() element. If you miss this, the toolbar will get messy.

 <main>
    {#  
        choose a project wide unique name to dis-/allow elements in your areablock 
        through the toolbox configuration (see section "allow/disallow elements" below
     #}
    {{ pimcore_areablock('mainContentBlock', toolbox_areablock_config('mainContentBlock')) }}
</main>

Toolbar Configuration

Of course, you're able to extend/modify the toolbar configuration:

area_block_configuration:
    toolbar:
        width: 200
        buttonWidth: 200
        buttonMaxCharacters: 40
    controlsAlign: 'top'
    controlsTrigger: 'hover'
        
    # define custom groups. Note: The "toolbox" group will be generated automatically.
    groups:
        -
            name: Project
            elements:
                - your_custom_area_brick

Allow/Disallow Elements

In snippets

Use the snippet_areas_appearance config node to disable bricks in specific snippets.

# define which elements should not appear in snippet documents
toolbox:
    snippet_areas_appearance:
        snippet_c:
            disallowed:
                - parallaxContainer
                - teaser
                - container
                - snippet
                - accordion
                - anchor
                - container
                - teaser
        accordion:
            allowed: # if "allowed" is configured the "disallowed" node will be ignored
                - teaser
                - download

In Area-Blocks

Use the areas_appearance config node to disable bricks in specific areas.

Example

toolbox:
    areas_appearance:
        container:
            allowed: # if "allowed" is configured the "disallowed" node will be ignored
                - container
                - parallaxContainer
        columns:
            disallowed:
                - container
                - parallaxContainer
        mainContentBlock: #this is a project related areablock example, see section "Area Brick Configuration" above.
            disallowed:
                - container
                - yourCustomBrick