FAF: Documentation UI Twig Blocks

This commit is contained in:
Eric
2021-05-28 17:28:12 +02:00
parent f90799d046
commit 33bd83d680
92 changed files with 3145 additions and 807 deletions

View File

@@ -0,0 +1,90 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
Toolbar
=======
Class Toolbar
----
.. include:: /manual/Component/Toolbar/ToolbarAdditionalDescription.rst
----
Twig Tag
--------
:Tag: **UIToolbar**
:Syntax:
::
{% UIToolbar Type {Parameters} %}
Content Goes Here
{% EndUIToolbar %}
:Type:
+-----------+------------+
| ForAction | No comment |
+-----------+------------+
| Standard | No comment |
+-----------+------------+
| ForButton | No comment |
+-----------+------------+
:Toolbar *ForAction* parameters:
+-----+--------+----------+------+--+
| sId | string | optional | NULL | |
+-----+--------+----------+------+--+
:Toolbar *Standard* parameters:
+-------------------+--------+----------+----------+--+
| sId | string | optional | NULL | |
+-------------------+--------+----------+----------+--+
| aContainerClasses | array | optional | array () | |
+-------------------+--------+----------+----------+--+
:Toolbar *ForButton* parameters:
+-------------------+--------+----------+----------+--+
| sId | string | optional | NULL | |
+-------------------+--------+----------+----------+--+
| aContainerClasses | array | optional | array () | |
+-------------------+--------+----------+----------+--+
:Toolbar common parameters:
+-------------------+----------+--------------------------------------------------------+
| AddCSSClass | string | |
+-------------------+----------+--------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+--------------------------------------------------------+
| AddCssFileRelPath | string | |
+-------------------+----------+--------------------------------------------------------+
| AddDeferredBlock | iUIBlock | |
+-------------------+----------+--------------------------------------------------------+
| AddHtml | string | |
+-------------------+----------+--------------------------------------------------------+
| AddJsFileRelPath | string | |
+-------------------+----------+--------------------------------------------------------+
| AddSubBlock | iUIBlock | |
+-------------------+----------+--------------------------------------------------------+
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+--------------------------------------------------------+
| DataAttributes | array | |
+-------------------+----------+--------------------------------------------------------+
| DeferredBlocks | array | |
+-------------------+----------+--------------------------------------------------------+
| IsHidden | bool | |
+-------------------+----------+--------------------------------------------------------+
| SubBlocks | array | |
+-------------------+----------+--------------------------------------------------------+
----
.. include:: /manual/Component/Toolbar/ToolbarFooter.rst