mirror of
https://github.com/Combodo/iTop.git
synced 2026-04-26 03:58:45 +02:00
FAF: Documentation UI Twig Blocks
This commit is contained in:
108
.doc/UI/source/generated/Component/Input/Input.rst
Normal file
108
.doc/UI/source/generated/Component/Input/Input.rst
Normal file
@@ -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
|
||||
Reference in New Issue
Block a user