FAF: Documentation UI Twig Blocks

This commit is contained in:
Eric
2021-05-28 22:46:30 +02:00
parent 541231ee5e
commit b87afed08a
23 changed files with 1226 additions and 274 deletions

View File

@@ -1,6 +1,8 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
.. _Toolbar:
Toolbar
=======
@@ -27,21 +29,47 @@ Twig Tag
:Type:
+-----------+------------+
| ForAction | No comment |
+-----------+------------+
| Standard | No comment |
+-----------+------------+
| ForButton | No comment |
+-----------+------------+
+-------------------------------------+------------+
| :ref:`ForAction <ToolbarForAction>` | No comment |
+-------------------------------------+------------+
| :ref:`Standard <ToolbarStandard>` | No comment |
+-------------------------------------+------------+
| :ref:`ForButton <ToolbarForButton>` | No comment |
+-------------------------------------+------------+
:Toolbar *ForAction* parameters:
.. _ToolbarForAction:
Toolbar ForAction
^^^^^^^^^^^^^^^^^
:syntax:
::
{% UIToolbar ForAction {sId:'value'} %}
Content Goes Here
{% EndUIToolbar %}
:parameters:
+-----+--------+----------+------+--+
| sId | string | optional | NULL | |
+-----+--------+----------+------+--+
:Toolbar *Standard* parameters:
.. _ToolbarStandard:
Toolbar Standard
^^^^^^^^^^^^^^^^
:syntax:
::
{% UIToolbar Standard {sId:'value', aContainerClasses:{name:value, name:value}} %}
Content Goes Here
{% EndUIToolbar %}
:parameters:
+-------------------+--------+----------+----------+--+
| sId | string | optional | NULL | |
@@ -49,7 +77,20 @@ Twig Tag
| aContainerClasses | array | optional | array () | |
+-------------------+--------+----------+----------+--+
:Toolbar *ForButton* parameters:
.. _ToolbarForButton:
Toolbar ForButton
^^^^^^^^^^^^^^^^^
:syntax:
::
{% UIToolbar ForButton {sId:'value', aContainerClasses:{name:value, name:value}} %}
Content Goes Here
{% EndUIToolbar %}
:parameters:
+-------------------+--------+----------+----------+--+
| sId | string | optional | NULL | |
@@ -57,8 +98,8 @@ Twig Tag
| aContainerClasses | array | optional | array () | |
+-------------------+--------+----------+----------+--+
:Toolbar common parameters:
Toolbar common parameters
^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------+----------+------------------------------------------------------------+
| AddCSSClass | string | CSS class to add to the generated html block |
+-------------------+----------+------------------------------------------------------------+

View File

@@ -1,6 +1,8 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
.. _ToolbarSpacer:
ToolbarSpacer
=============
@@ -25,18 +27,29 @@ Twig Tag
:Type:
+----------+-------------------------+
| Standard | @param string|null $sId |
+----------+-------------------------+
+-----------------------------------------+-------------------------+
| :ref:`Standard <ToolbarSpacerStandard>` | @param string|null $sId |
+-----------------------------------------+-------------------------+
:ToolbarSpacer *Standard* parameters:
.. _ToolbarSpacerStandard:
ToolbarSpacer Standard
^^^^^^^^^^^^^^^^^^^^^^
:syntax:
::
{% UIToolbarSpacer Type Standard {sId:'value'} %}
:parameters:
+-----+--------+----------+------+--+
| sId | string | optional | NULL | |
+-----+--------+----------+------+--+
:ToolbarSpacer common parameters:
ToolbarSpacer common parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------+--------+------------------------------------------------------------+
| AddCSSClass | string | CSS class to add to the generated html block |
+-------------------+--------+------------------------------------------------------------+