|
| 1 | +Accordion component |
| 2 | +################### |
| 3 | + |
| 4 | +Introduction |
| 5 | +************ |
| 6 | + |
| 7 | +The Accordion Component allows developers to create collapsible sections within their Mautic templates. This Component is useful for organizing content into expandable and collapsible panels, enhancing the User experience by making large amounts of content more manageable. |
| 8 | + |
| 9 | + |
| 10 | +Template structure |
| 11 | +****************** |
| 12 | + |
| 13 | +The ``accordion.html.twig`` template defines this accordion component. The template employs a list structure ``<ul>`` where each item ``<li>`` represents an accordion panel. Each panel consists of a heading and a collapsible content section. |
| 14 | + |
| 15 | +Key features |
| 16 | +============ |
| 17 | + |
| 18 | +- Clicking on the heading expands or collapses each accordion item. |
| 19 | +- The component includes ARIA attributes to improve accessibility. |
| 20 | +- You can customize the content of each accordion panel using Twig variables. |
| 21 | + |
| 22 | +Applying the accordion component |
| 23 | +================================ |
| 24 | + |
| 25 | +To use the accordion component, include it in your template and pass the necessary data. |
| 26 | + |
| 27 | +Define the content you want to include in the accordion. For example, if you want to include a group of UTM tags fields, you can define the content as follows: |
| 28 | + |
| 29 | +.. code-block:: twig |
| 30 | +
|
| 31 | + {% set utmTagsContent %} |
| 32 | + {% for i, utmTag in form.utmTags %} |
| 33 | + {{ form_row(utmTag) }} |
| 34 | + {% endfor %} |
| 35 | + {% endset %} |
| 36 | +
|
| 37 | +.. vale off |
| 38 | +
|
| 39 | +.. note:: |
| 40 | + For instance, you can loop over Form fields or any other data to generate the content dynamically. |
| 41 | + |
| 42 | +.. vale on |
| 43 | +
|
| 44 | +Include the ``accordion.html.twig`` template in your main template and pass an array of items. Each item should have: |
| 45 | + |
| 46 | +- ``id``: a unique identifier. |
| 47 | +- ``title``: the title of the accordion item. |
| 48 | +- ``padding_inline``: optional boolean to control padding within the content. Defaults to true if not defined. |
| 49 | +- ``content``: the content displays when the item expands. |
| 50 | + |
| 51 | +Example: |
| 52 | + |
| 53 | +.. code-block:: twig |
| 54 | +
|
| 55 | + {% include '@MauticCore/Helper/accordion.html.twig' with { |
| 56 | + 'items': [ |
| 57 | + { |
| 58 | + 'id': 'UTM', |
| 59 | + 'title': 'mautic.email.utm_tags', |
| 60 | + 'padding_inline': false, |
| 61 | + 'content': utmTagsContent, |
| 62 | + } |
| 63 | + ] |
| 64 | + } %} |
| 65 | +
|
| 66 | +While defining a ``set`` block separately isn't strictly necessary, it can be helpful to ensure that operations relying on Twig functions keep working correctly. The ``set`` block allows you to predefine complex content or operations, making your template cleaner and more maintainable. |
| 67 | + |
| 68 | +Example without the ``set`` block |
| 69 | +--------------------------------- |
| 70 | + |
| 71 | +If your content is simple, you can directly include it within the ``items`` array without using a ``set`` block. Here's an example: |
| 72 | + |
| 73 | +.. code-block:: twig |
| 74 | +
|
| 75 | + {% include '@MauticCore/Helper/accordion.html.twig' with { |
| 76 | + 'items': [ |
| 77 | + { |
| 78 | + 'id': 'Example', |
| 79 | + 'title': 'Example Title', |
| 80 | + 'padding_inline': true, |
| 81 | + 'content': '<p>This is a simple content example.</p>', |
| 82 | + } |
| 83 | + ] |
| 84 | + } %} |
| 85 | +
|
| 86 | +This flexibility allows you to choose the best approach based on each case. |
| 87 | + |
| 88 | +Automatic CSS handling |
| 89 | +====================== |
| 90 | + |
| 91 | +When using the Component, all necessary CSS styles are automatically handled for you. This means that the Component comes pre-styled with classes such as ``accordion-heading``, ``accordion-wrapper``, and ``accordion-content``, ensuring a consistent and visually appealing appearance out of the box. |
| 92 | + |
| 93 | +- The Component includes predefined CSS classes that manage the layout, spacing, and interactive elements of the accordion. |
| 94 | +- You don't need to add any extra CSS to make the accordion function and look visually appealing. |
| 95 | +- It uses the existing Bootstrap function for collapsing panels. |
| 96 | +- Avoid overriding these classes in your own CSS. |
| 97 | + |
| 98 | +The design of the accordion makes it easy to implement, with all essential CSS styles already in place. This allows you to focus on integrating and using the component without worrying about additional styling. |
| 99 | + |
| 100 | +Complete example |
| 101 | +================ |
| 102 | + |
| 103 | +Here is a complete example that demonstrates how to use the accordion Component in a Mautic template: |
| 104 | + |
| 105 | +.. code-block:: twig |
| 106 | +
|
| 107 | + {% set utmTagsContent %} |
| 108 | + {% for i, utmTag in form.utmTags %} |
| 109 | + {{ form_row(utmTag) }} |
| 110 | + {% endfor %} |
| 111 | + {% endset %} |
| 112 | +
|
| 113 | + {% include '@MauticCore/Helper/accordion.html.twig' with { |
| 114 | + 'items': [ |
| 115 | + { |
| 116 | + 'id': 'UTM', |
| 117 | + 'title': 'mautic.email.utm_tags', |
| 118 | + 'padding_inline': false, |
| 119 | + 'content': utmTagsContent, |
| 120 | + } |
| 121 | + ] |
| 122 | + } %} |
| 123 | +
|
| 124 | +For more complex structures, with dozens of accordion items, you might prefer to copy the structure and build something unique, but the best approach would be to place each content under a set block. |
0 commit comments