FAF: Documentation UI Twig Blocks

.doc/UI/source/generated/Component/Input/FileSelect/FileSelect.rst

@@ -0,0 +1,68 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+FileSelect
+==========
+
+Class FileSelect
+
+----
+
+.. include:: /manual/Component/Input/FileSelect/FileSelectAdditionalDescription.rst
+
+----
+
+Twig Tag
+--------
+
+:Tag: **UIFileSelect**
+
+:Syntax:
+ 
+::
+
+    {% UIFileSelect Type {Parameters} %}
+
+:Type:
+
++----------+------------+
+| Standard | No comment |
++----------+------------+
+
+:FileSelect *Standard* parameters:
+
++-------+--------+-----------+------+--+
+| sName | string | mandatory |      |  |
++-------+--------+-----------+------+--+
+| sId   | string | optional  | NULL |  |
++-------+--------+-----------+------+--+
+
+:FileSelect common parameters:
+
++-------------------+--------+--------------------------------------------------------+
+| AddCSSClass       | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| AddCSSClasses     | array  | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
++-------------------+--------+--------------------------------------------------------+
+| AddCssFileRelPath | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| AddHtml           | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| AddJsFileRelPath  | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| ButtonText        | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| CSSClasses        | array  | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
++-------------------+--------+--------------------------------------------------------+
+| DataAttributes    | array  |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| FileName          |        |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| IsHidden          | bool   |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| ShowFilename      | bool   |                                                        |
++-------------------+--------+--------------------------------------------------------+
+
+----
+
+.. include:: /manual/Component/Input/FileSelect/FileSelectFooter.rst

.doc/UI/source/generated/Component/Input/Input.rst

@@ -0,0 +1,108 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+Input
+=====
+
+Class Input
+
+----
+
+.. include:: /manual/Component/Input/InputAdditionalDescription.rst
+
+----
+
+Twig Tag
+--------
+
+:Tag: **UIInput**
+
+:Syntax:
+ 
+::
+
+    {% UIInput Type {Parameters} %}
+
+:Type:
+
++-------------------+------------------------------------------------------------------------------------+
+| ForHidden         | No comment                                                                         |
++-------------------+------------------------------------------------------------------------------------+
+| Standard          | No comment                                                                         |
++-------------------+------------------------------------------------------------------------------------+
+| ForInputWithLabel | @see Field component that is better adapter when dealing with a standard iTop form |
++-------------------+------------------------------------------------------------------------------------+
+
+:Input *ForHidden* parameters:
+
++--------+--------+-----------+------+--+
+| sName  | string | mandatory |      |  |
++--------+--------+-----------+------+--+
+| sValue | string | mandatory |      |  |
++--------+--------+-----------+------+--+
+| sId    | string | optional  | NULL |  |
++--------+--------+-----------+------+--+
+
+:Input *Standard* parameters:
+
++--------+--------+-----------+------+--+
+| sType  | string | mandatory |      |  |
++--------+--------+-----------+------+--+
+| sName  | string | mandatory |      |  |
++--------+--------+-----------+------+--+
+| sValue | string | mandatory |      |  |
++--------+--------+-----------+------+--+
+| sId    | string | optional  | NULL |  |
++--------+--------+-----------+------+--+
+
+:Input *ForInputWithLabel* parameters:
+
++-------------+--------+-----------+--------+--+
+| sLabel      | string | mandatory |        |  |
++-------------+--------+-----------+--------+--+
+| sInputName  | string | mandatory |        |  |
++-------------+--------+-----------+--------+--+
+| sInputValue | string | optional  | NULL   |  |
++-------------+--------+-----------+--------+--+
+| sInputId    | string | optional  | NULL   |  |
++-------------+--------+-----------+--------+--+
+| sInputType  | string | optional  | 'type' |  |
++-------------+--------+-----------+--------+--+
+
+:Input common parameters:
+
++-------------------+--------+--------------------------------------------------------+
+| AddCSSClass       | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| AddCSSClasses     | array  | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
++-------------------+--------+--------------------------------------------------------+
+| AddCssFileRelPath | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| AddHtml           | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| AddJsFileRelPath  | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| CSSClasses        | array  | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
++-------------------+--------+--------------------------------------------------------+
+| DataAttributes    | array  |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| IsChecked         |        |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| IsDisabled        | bool   |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| IsHidden          | bool   |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| IsReadonly        | bool   |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| Name              | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| Placeholder       | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| Type              | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| Value             | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+
+----
+
+.. include:: /manual/Component/Input/InputFooter.rst

.doc/UI/source/generated/Component/Input/Select/Select.rst

@@ -0,0 +1,94 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+Select
+======
+
+Class Select
+
+----
+
+.. include:: /manual/Component/Input/Select/SelectAdditionalDescription.rst
+
+----
+
+Twig Tag
+--------
+
+:Tag: **UISelect**
+
+:Syntax:
+ 
+::
+
+    {% UISelect Type {Parameters} %}
+        Content Goes Here
+    {% EndUISelect %}
+
+:Type:
+
++--------------------+------------------------------------------------------------------------------------------------+
+| ForSelect          | @param string $sName                                                                           |
++--------------------+------------------------------------------------------------------------------------------------+
+| ForSelectWithLabel | If you need to have a real field with a label, you might use a {@link Field} component instead |
++--------------------+------------------------------------------------------------------------------------------------+
+
+:Select *ForSelect* parameters:
+
++-------+--------+-----------+------+--+
+| sName | string | mandatory |      |  |
++-------+--------+-----------+------+--+
+| sId   | string | optional  | NULL |  |
++-------+--------+-----------+------+--+
+
+:Select *ForSelectWithLabel* parameters:
+
++--------+--------+-----------+------+--+
+| sName  | string | mandatory |      |  |
++--------+--------+-----------+------+--+
+| sLabel | string | mandatory |      |  |
++--------+--------+-----------+------+--+
+| sId    | string | optional  | NULL |  |
++--------+--------+-----------+------+--+
+
+:Select common parameters:
+
++-------------------+--------------+--------------------------------------------------------+
+| AddCSSClass       | string       |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| AddCSSClasses     | array        | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
++-------------------+--------------+--------------------------------------------------------+
+| AddCssFileRelPath | string       |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| AddDeferredBlock  | iUIBlock     |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| AddHtml           | string       |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| AddJsFileRelPath  | string       |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| AddOption         | SelectOption |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| AddSubBlock       | iUIBlock     |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| CSSClasses        | array        | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
++-------------------+--------------+--------------------------------------------------------+
+| DataAttributes    | array        |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| DeferredBlocks    | array        |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| IsHidden          | bool         |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| IsMultiple        | bool         |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| Name              | string       |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| SubBlocks         | array        |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| SubmitOnChange    | bool         |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+| Value             | string       |                                                        |
++-------------------+--------------+--------------------------------------------------------+
+
+----
+
+.. include:: /manual/Component/Input/Select/SelectFooter.rst

.doc/UI/source/generated/Component/Input/Select/SelectOption.rst

@@ -0,0 +1,74 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+SelectOption
+============
+
+Class SelectOption
+
+----
+
+.. include:: /manual/Component/Input/Select/SelectOptionAdditionalDescription.rst
+
+----
+
+Twig Tag
+--------
+
+:Tag: **UISelectOption**
+
+:Syntax:
+ 
+::
+
+    {% UISelectOption Type {Parameters} %}
+
+:Type:
+
++-----------------+------------+
+| ForSelectOption | No comment |
++-----------------+------------+
+
+:SelectOption *ForSelectOption* parameters:
+
++-----------+--------+-----------+------+--+
+| sValue    | string | mandatory |      |  |
++-----------+--------+-----------+------+--+
+| sLabel    | string | mandatory |      |  |
++-----------+--------+-----------+------+--+
+| bSelected | bool   | mandatory |      |  |
++-----------+--------+-----------+------+--+
+| sId       | string | optional  | NULL |  |
++-----------+--------+-----------+------+--+
+
+:SelectOption common parameters:
+
++-------------------+--------+--------------------------------------------------------+
+| AddCSSClass       | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| AddCSSClasses     | array  | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
++-------------------+--------+--------------------------------------------------------+
+| AddCssFileRelPath | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| AddHtml           | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| AddJsFileRelPath  | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| CSSClasses        | array  | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
++-------------------+--------+--------------------------------------------------------+
+| DataAttributes    | array  |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| Disabled          | bool   |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| IsHidden          | bool   |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| Label             | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| Selected          | bool   |                                                        |
++-------------------+--------+--------------------------------------------------------+
+| Value             | string |                                                        |
++-------------------+--------+--------------------------------------------------------+
+
+----
+
+.. include:: /manual/Component/Input/Select/SelectOptionFooter.rst