composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-25 19:48:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

FAF: Documentation UI Twig Blocks

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

94
.doc/UI/source/generated/Component/Input/Select/Select.rst Normal file
View File

@@ -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

74
.doc/UI/source/generated/Component/Input/Select/SelectOption.rst Normal file
View File

@@ -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