mirror of
https://github.com/Combodo/iTop.git
synced 2026-04-26 20:18:52 +02:00
FAF: Documentation UI Twig Blocks - HTML result
This commit is contained in:
@@ -0,0 +1,92 @@
|
||||
.. 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:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIFieldSet Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIFieldSet %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------------------------------+------------+
|
||||
| :ref:`Standard <FieldSetStandard>` | No comment |
|
||||
+------------------------------------+------------+
|
||||
|
||||
.. _FieldSetStandard:
|
||||
|
||||
FieldSet Standard
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% 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 | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| 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
|
||||
Reference in New Issue
Block a user