Files
iTop/.doc/UI/source/generated/Component/Input/Input.rst
2021-05-28 18:08:15 +02:00

109 lines
5.2 KiB
ReStructuredText

.. 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 | CSS class to add to the generated html block |
+-------------------+--------+------------------------------------------------------------+
| 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 | Array of data attributes in the format ['name' => 'value'] |
+-------------------+--------+------------------------------------------------------------+
| IsChecked | | |
+-------------------+--------+------------------------------------------------------------+
| IsDisabled | bool | |
+-------------------+--------+------------------------------------------------------------+
| IsHidden | bool | Indicates if the block is hidden by default |
+-------------------+--------+------------------------------------------------------------+
| IsReadonly | bool | |
+-------------------+--------+------------------------------------------------------------+
| Name | string | |
+-------------------+--------+------------------------------------------------------------+
| Placeholder | string | |
+-------------------+--------+------------------------------------------------------------+
| Type | string | |
+-------------------+--------+------------------------------------------------------------+
| Value | string | |
+-------------------+--------+------------------------------------------------------------+
----
.. include:: /manual/Component/Input/InputFooter.rst