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,74 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
Form
====
Class Form
----
.. include:: /manual/Component/Form/FormAdditionalDescription.rst
----
Twig Tag
--------
:Tag: **UIForm**
:Syntax:
::
{% UIForm Type {Parameters} %}
Content Goes Here
{% EndUIForm %}
:Type:
+----------+------------+
| Standard | No comment |
+----------+------------+
:Form *Standard* parameters:
+-----+--------+----------+------+--+
| sId | string | optional | NULL | |
+-----+--------+----------+------+--+
:Form common parameters:
+-------------------+----------+--------------------------------------------------------+
| Action | string | |
+-------------------+----------+--------------------------------------------------------+
| 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 | |
+-------------------+----------+--------------------------------------------------------+
| OnSubmitJsCode | string | |
+-------------------+----------+--------------------------------------------------------+
| SubBlocks | array | |
+-------------------+----------+--------------------------------------------------------+
----
.. include:: /manual/Component/Form/FormFooter.rst