.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0

.. _FieldSet:

FieldSet
========

Class FieldSet

----

.. include:: /manual/Component/FieldSet/FieldSetAdditionalDescription.rst

----

Twig Tag
--------

:Tag: **UIFieldSet**

:Syntax:
 
::

    {% UIFieldSet Type {Parameters} %}
        Content Goes Here
    {% EndUIFieldSet %}

:Type:

+------------------------------------+------------+
| :ref:`Standard <FieldSetStandard>` | No comment |
+------------------------------------+------------+

.. _FieldSetStandard:

FieldSet Standard
^^^^^^^^^^^^^^^^^

:syntax:

::

    {% UIFieldSet Standard {sLegend:'value', sId:'value'} %}
        Content Goes Here
    {% EndUIFieldSet %}

:parameters:

+---------+--------+-----------+------+--+
| sLegend | string | mandatory |      |  |
+---------+--------+-----------+------+--+
| sId     | string | optional  | NULL |  |
+---------+--------+-----------+------+--+

FieldSet common parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------+----------+------------------------------------------------------------+
| AddCSSClass       | string   | CSS class to add to the generated html block               |
+-------------------+----------+------------------------------------------------------------+
| AddCSSClasses     | array    | like <code>['ibo-is-hidden', 'ibo-alert--body']</code>     |
+-------------------+----------+------------------------------------------------------------+
| AddCssFileRelPath | string   | relative path of a CSS file to add                         |
+-------------------+----------+------------------------------------------------------------+
| AddDeferredBlock  | iUIBlock |                                                            |
+-------------------+----------+------------------------------------------------------------+
| AddHtml           | string   |                                                            |
+-------------------+----------+------------------------------------------------------------+
| AddJsFileRelPath  | string   | relative path of a JS file to add                          |
+-------------------+----------+------------------------------------------------------------+
| AddSubBlock       | iUIBlock |                                                            |
+-------------------+----------+------------------------------------------------------------+
| CSSClasses        | array    | like <code>['ibo-is-hidden', 'ibo-alert--body']</code>     |
+-------------------+----------+------------------------------------------------------------+
| DataAttributes    | array    | Array of data attributes in the format ['name' => 'value'] |
+-------------------+----------+------------------------------------------------------------+
| DeferredBlocks    | array    |                                                            |
+-------------------+----------+------------------------------------------------------------+
| IsHidden          | bool     | Indicates if the block is hidden by default                |
+-------------------+----------+------------------------------------------------------------+
| SubBlocks         | array    |                                                            |
+-------------------+----------+------------------------------------------------------------+

----

.. include:: /manual/Component/FieldSet/FieldSetFooter.rst