mirror of
https://github.com/Combodo/iTop.git
synced 2026-04-29 13:38:44 +02:00
FAF: Documentation UI Twig Blocks
This commit is contained in:
Eric
171
.doc/UI/source/generated/Component/Alert/Alert.rst
Normal file
171
.doc/UI/source/generated/Component/Alert/Alert.rst
Normal file
@@ -0,0 +1,171 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Alert
|
||||
=====
|
||||
|
||||
Alerts are the main component to give feedback to the user or communicate page specific to system wide messages.
|
||||
Alerts are a rectangular component displaying a title and a message.
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Alert/AlertAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIAlert**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIAlert Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIAlert %}
|
||||
|
||||
:Type:
|
||||
|
||||
+----------------------------+-----------------------------------------------------+
|
||||
| Neutral | Make a basis Alert component |
|
||||
+----------------------------+-----------------------------------------------------+
|
||||
| ForInformation | Make an Alert component for informational messages |
|
||||
+----------------------------+-----------------------------------------------------+
|
||||
| ForSuccess | Make an Alert component for successful messages |
|
||||
+----------------------------+-----------------------------------------------------+
|
||||
| ForWarning | Make an Alert component for warning messages |
|
||||
+----------------------------+-----------------------------------------------------+
|
||||
| ForDanger | Make an Alert component for danger messages |
|
||||
+----------------------------+-----------------------------------------------------+
|
||||
| ForFailure | Make an Alert component for failure messages |
|
||||
+----------------------------+-----------------------------------------------------+
|
||||
| WithBrandingPrimaryColor | Make an Alert component with primary color scheme |
|
||||
+----------------------------+-----------------------------------------------------+
|
||||
| WithBrandingSecondaryColor | Make an Alert component with secondary color scheme |
|
||||
+----------------------------+-----------------------------------------------------+
|
||||
|
||||
:Alert *Neutral* parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
:Alert *ForInformation* parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
:Alert *ForSuccess* parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
:Alert *ForWarning* parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
:Alert *ForDanger* parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
:Alert *ForFailure* parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
:Alert *WithBrandingPrimaryColor* parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
:Alert *WithBrandingSecondaryColor* parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
:Alert common parameters:
|
||||
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| 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> |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| Color | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| Content | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| DataAttributes | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| IsClosable | bool | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| IsCollapsible | bool | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| OpenedByDefault | bool | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| Title | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Alert/AlertFooter.rst
|
||||
306
.doc/UI/source/generated/Component/Button/Button.rst
Normal file
306
.doc/UI/source/generated/Component/Button/Button.rst
Normal file
@@ -0,0 +1,306 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Button
|
||||
======
|
||||
|
||||
Class Button
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Button/ButtonAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIButton**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIButton Type {Parameters} %}
|
||||
|
||||
:Type:
|
||||
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Neutral | Make a basis Button component for any purpose |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| ForPrimaryAction | Make a Button component for a primary action, should be used to tell the user this is the main choice |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| ForSecondaryAction | Make a Button component for a secondary action, should be used to tell the user this is an second hand choice |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| ForPositiveAction | Make a Button component for a success action, should be used to tell the user he/she going to make a positive action/choice |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| ForDestructiveAction | Make a Button component for a destructive action, should be used to tell the user he/she going to make something that cannot be |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| AlternativeNeutral | Make a basis Button component for any purpose |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| ForAlternativePrimaryAction | Make a Button component for an alternative primary action, should be used to avoid the user to consider this action as the first |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| ForAlternativeSecondaryAction | Make a Button component for an alternative secondary action, should be used to avoid the user to focus on this |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| ForAlternativeValidationAction | Make a Button component for a validation action, should be used to avoid the user to focus on this |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| ForAlternativeDestructiveAction | Make a Button component for a destructive action, should be used to avoid the user to focus on this |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| ForCancel | Make a Button component for a cancel, should be used only for UI navigation, not destructive action |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| IconAction | @param string $sIconClasses |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| LinkNeutral | Make a link Button component to open an URL instead of triggering a form action |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| IconLink | @param string $sIconClasses |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| DestructiveIconLink | @param string $sIconClasses |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
:Button *Neutral* parameters:
|
||||
|
||||
+--------+--------+-----------+------+----------------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+--------+--------+-----------+------+----------------------------+
|
||||
| sName | string | optional | NULL | See {@link Button::$sName} |
|
||||
+--------+--------+-----------+------+----------------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+--------+-----------+------+----------------------------+
|
||||
|
||||
:Button *ForPrimaryAction* parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
:Button *ForSecondaryAction* parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
:Button *ForPositiveAction* parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
:Button *ForDestructiveAction* parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
:Button *AlternativeNeutral* parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
:Button *ForAlternativePrimaryAction* parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
:Button *ForAlternativeSecondaryAction* parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
:Button *ForAlternativeValidationAction* parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
:Button *ForAlternativeDestructiveAction* parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
:Button *ForCancel* parameters:
|
||||
|
||||
+-----------+--------+----------+-------+---------------------+
|
||||
| sLabel | string | optional | NULL | |
|
||||
+-----------+--------+----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+----------+-------+---------------------+
|
||||
|
||||
:Button *IconAction* parameters:
|
||||
|
||||
+--------------+--------+-----------+-------+--+
|
||||
| sIconClasses | string | mandatory | | |
|
||||
+--------------+--------+-----------+-------+--+
|
||||
| sTooltipText | string | optional | '' | |
|
||||
+--------------+--------+-----------+-------+--+
|
||||
| sName | string | optional | NULL | |
|
||||
+--------------+--------+-----------+-------+--+
|
||||
| sValue | string | optional | NULL | |
|
||||
+--------------+--------+-----------+-------+--+
|
||||
| bIsSubmit | bool | optional | false | |
|
||||
+--------------+--------+-----------+-------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------------+--------+-----------+-------+--+
|
||||
|
||||
:Button *LinkNeutral* parameters:
|
||||
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sURL | string | mandatory | | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sLabel | string | optional | '' | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sIconClasses | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sTarget | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
|
||||
:Button *IconLink* parameters:
|
||||
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sIconClasses | string | mandatory | | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sTooltipText | string | mandatory | | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sURL | string | optional | '' | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sTarget | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
|
||||
:Button *DestructiveIconLink* parameters:
|
||||
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sIconClasses | string | mandatory | | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sTooltipText | string | mandatory | | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sURL | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sName | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sTarget | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
|
||||
:Button common parameters:
|
||||
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
| ActionType | string | |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
| 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> |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
| Color | string | |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
| DataAttributes | array | |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
| IconClass | string | |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
| JsCode | string | |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
| Label | string | |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
| OnClickJsCode | string | |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
| Tooltip | string | |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Button/ButtonFooter.rst
|
||||
@@ -0,0 +1,70 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
ButtonGroup
|
||||
===========
|
||||
|
||||
Class ButtonGroup
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/ButtonGroup/ButtonGroupAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIButtonGroup**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIButtonGroup Type {Parameters} %}
|
||||
|
||||
:Type:
|
||||
|
||||
+-----------------------+--------------------------------------------------------------------------------------------------+
|
||||
| ButtonWithOptionsMenu | Make a button that has a primary action ($oButton) but also an options menu ($oMenu) on the side |
|
||||
+-----------------------+--------------------------------------------------------------------------------------------------+
|
||||
|
||||
:ButtonGroup *ButtonWithOptionsMenu* parameters:
|
||||
|
||||
+---------+-------------+-----------+--+--+
|
||||
| oButton | Button | mandatory | | |
|
||||
+---------+-------------+-----------+--+--+
|
||||
| oMenu | PopoverMenu | mandatory | | |
|
||||
+---------+-------------+-----------+--+--+
|
||||
|
||||
:ButtonGroup common parameters:
|
||||
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddButton | Button | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddButtons | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddCSSClass | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddExtraBlock | iUIBlock | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| Buttons | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| DataAttributes | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/ButtonGroup/ButtonGroupFooter.rst
|
||||
@@ -0,0 +1,74 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
CollapsibleSection
|
||||
==================
|
||||
|
||||
Class CollapsibleSection
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/CollapsibleSection/CollapsibleSectionAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UICollapsibleSection**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UICollapsibleSection Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUICollapsibleSection %}
|
||||
|
||||
:Type:
|
||||
|
||||
+----------+------------+
|
||||
| Standard | No comment |
|
||||
+----------+------------+
|
||||
|
||||
:CollapsibleSection *Standard* parameters:
|
||||
|
||||
+--------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+--------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+--------+-----------+------+--+
|
||||
|
||||
:CollapsibleSection common parameters:
|
||||
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| 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 | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| OpenedByDefault | bool | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/CollapsibleSection/CollapsibleSectionFooter.rst
|
||||
31
.doc/UI/source/generated/Component/Component.rst
Normal file
31
.doc/UI/source/generated/Component/Component.rst
Normal file
@@ -0,0 +1,31 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
UI Component
|
||||
============
|
||||
|
||||
A UI component is a unitary block used to display information in iTop console.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Components:
|
||||
|
||||
Alert/Alert
|
||||
Title/Title
|
||||
FieldSet/FieldSet
|
||||
Field/Field
|
||||
Button/Button
|
||||
ButtonGroup/ButtonGroup
|
||||
CollapsibleSection/CollapsibleSection
|
||||
DataTable/DataTable
|
||||
FieldBadge/FieldBadge
|
||||
Form/Form
|
||||
Input/Input
|
||||
Input/FileSelect/FileSelect
|
||||
Input/Select/Select
|
||||
Input/Select/SelectOption
|
||||
Panel/Panel
|
||||
Spinner/Spinner
|
||||
Toolbar/Toolbar
|
||||
Toolbar/ToolbarSpacer/ToolbarSpacer
|
||||
160
.doc/UI/source/generated/Component/DataTable/DataTable.rst
Normal file
160
.doc/UI/source/generated/Component/DataTable/DataTable.rst
Normal file
@@ -0,0 +1,160 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
DataTable
|
||||
=========
|
||||
|
||||
Class DataTable
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/DataTable/DataTableAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIDataTable**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIDataTable Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIDataTable %}
|
||||
|
||||
:Type:
|
||||
|
||||
+--------------------+------------------------------+
|
||||
| ForResult | @param \WebPage $oPage |
|
||||
+--------------------+------------------------------+
|
||||
| ForObject | @param \WebPage $oPage |
|
||||
+--------------------+------------------------------+
|
||||
| ForRendering | Make a basis Panel component |
|
||||
+--------------------+------------------------------+
|
||||
| ForRenderingObject | @param string $sListId |
|
||||
+--------------------+------------------------------+
|
||||
| ForStaticData | No comment |
|
||||
+--------------------+------------------------------+
|
||||
| ForForm | @param string $sRef |
|
||||
+--------------------+------------------------------+
|
||||
|
||||
:DataTable *ForResult* parameters:
|
||||
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| oPage | WebPage | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| sListId | string | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| oSet | DBObjectSet | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| aExtraParams | | optional | array () | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
|
||||
:DataTable *ForObject* parameters:
|
||||
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| oPage | WebPage | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| sListId | string | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| oSet | DBObjectSet | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| aExtraParams | | optional | array () | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
|
||||
:DataTable *ForRendering* parameters:
|
||||
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| sListId | string | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| oSet | DBObjectSet | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| aExtraParams | | optional | array () | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
|
||||
:DataTable *ForRenderingObject* parameters:
|
||||
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| sListId | string | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| oSet | DBObjectSet | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| aExtraParams | | optional | array () | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
|
||||
:DataTable *ForStaticData* parameters:
|
||||
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| aColumns | array | mandatory | | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| aData | array | mandatory | | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| aExtraParams | array | optional | array () | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| sFilter | string | optional | '' | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| aOptions | array | optional | array () | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
|
||||
:DataTable *ForForm* parameters:
|
||||
|
||||
+----------+--------+-----------+----------+--+
|
||||
| sRef | string | mandatory | | |
|
||||
+----------+--------+-----------+----------+--+
|
||||
| aColumns | array | mandatory | | |
|
||||
+----------+--------+-----------+----------+--+
|
||||
| aData | array | optional | array () | |
|
||||
+----------+--------+-----------+----------+--+
|
||||
| sFilter | string | optional | '' | |
|
||||
+----------+--------+-----------+----------+--+
|
||||
|
||||
:DataTable common parameters:
|
||||
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddCSSClass | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AjaxData | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AjaxUrl | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| DataAttributes | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| DisplayColumns | | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| JSRefresh | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| Options | | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| ResultColumns | | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/DataTable/DataTableFooter.rst
|
||||
146
.doc/UI/source/generated/Component/Field/Field.rst
Normal file
146
.doc/UI/source/generated/Component/Field/Field.rst
Normal file
@@ -0,0 +1,146 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Field
|
||||
=====
|
||||
|
||||
Class Field
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Field/FieldAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIField**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIField Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIField %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------+------------+
|
||||
| FromParams | No comment |
|
||||
+------------+------------+
|
||||
| FromObject | No comment |
|
||||
+------------+------------+
|
||||
| Large | No comment |
|
||||
+------------+------------+
|
||||
| Small | No comment |
|
||||
+------------+------------+
|
||||
| Standard | No comment |
|
||||
+------------+------------+
|
||||
|
||||
:Field *FromParams* parameters:
|
||||
|
||||
+---------+--+-----------+--+--+
|
||||
| aParams | | mandatory | | |
|
||||
+---------+--+-----------+--+--+
|
||||
|
||||
:Field *FromObject* parameters:
|
||||
|
||||
+---------+---------+-----------+------+--+
|
||||
| sLabel | string | mandatory | | |
|
||||
+---------+---------+-----------+------+--+
|
||||
| oInput | UIBlock | mandatory | | |
|
||||
+---------+---------+-----------+------+--+
|
||||
| sLayout | string | optional | NULL | |
|
||||
+---------+---------+-----------+------+--+
|
||||
|
||||
:Field *Large* parameters:
|
||||
|
||||
+------------+--------+-----------+----+--+
|
||||
| sLabel | string | mandatory | | |
|
||||
+------------+--------+-----------+----+--+
|
||||
| sValueHtml | string | optional | '' | |
|
||||
+------------+--------+-----------+----+--+
|
||||
|
||||
:Field *Small* parameters:
|
||||
|
||||
+------------+--------+-----------+----+--+
|
||||
| sLabel | string | mandatory | | |
|
||||
+------------+--------+-----------+----+--+
|
||||
| sValueHtml | string | optional | '' | |
|
||||
+------------+--------+-----------+----+--+
|
||||
|
||||
:Field *Standard* parameters:
|
||||
|
||||
+---------+--------+----------+---------+--+
|
||||
| sLabel | string | optional | '' | |
|
||||
+---------+--------+----------+---------+--+
|
||||
| sLayout | string | optional | 'small' | |
|
||||
+---------+--------+----------+---------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+---------+--------+----------+---------+--+
|
||||
|
||||
:Field common parameters:
|
||||
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddCSSClass | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AttCode | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AttLabel | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AttType | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| Comments | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| DataAttributes | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| InputId | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| InputType | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| IsMandatory | bool | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| IsReadOnly | bool | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| IsSlave | bool | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| Label | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| Layout | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| MustChange | bool | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| MustPrompt | bool | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| Value | UIBlock | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| ValueId | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| ValueRaw | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Field/FieldFooter.rst
|
||||
72
.doc/UI/source/generated/Component/FieldBadge/FieldBadge.rst
Normal file
72
.doc/UI/source/generated/Component/FieldBadge/FieldBadge.rst
Normal file
@@ -0,0 +1,72 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
FieldBadge
|
||||
==========
|
||||
|
||||
Class FieldBadge
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/FieldBadge/FieldBadgeAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIFieldBadge**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIFieldBadge Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIFieldBadge %}
|
||||
|
||||
:Type:
|
||||
|
||||
+----------+-----------------------+
|
||||
| ForField | @param string $sValue |
|
||||
+----------+-----------------------+
|
||||
|
||||
:FieldBadge *ForField* parameters:
|
||||
|
||||
+--------+----------+-----------+--+--+
|
||||
| sValue | string | mandatory | | |
|
||||
+--------+----------+-----------+--+--+
|
||||
| oStyle | ormStyle | mandatory | | |
|
||||
+--------+----------+-----------+--+--+
|
||||
|
||||
:FieldBadge common parameters:
|
||||
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| 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 | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/FieldBadge/FieldBadgeFooter.rst
|
||||
72
.doc/UI/source/generated/Component/FieldSet/FieldSet.rst
Normal file
72
.doc/UI/source/generated/Component/FieldSet/FieldSet.rst
Normal file
@@ -0,0 +1,72 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
FieldSet
|
||||
========
|
||||
|
||||
Class FieldSet
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/FieldSet/FieldSetAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIFieldSet**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIFieldSet Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIFieldSet %}
|
||||
|
||||
:Type:
|
||||
|
||||
+----------+------------+
|
||||
| Standard | No comment |
|
||||
+----------+------------+
|
||||
|
||||
:FieldSet *Standard* parameters:
|
||||
|
||||
+---------+--------+-----------+------+--+
|
||||
| sLegend | string | mandatory | | |
|
||||
+---------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+---------+--------+-----------+------+--+
|
||||
|
||||
:FieldSet common parameters:
|
||||
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| 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 | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/FieldSet/FieldSetFooter.rst
|
||||
74
.doc/UI/source/generated/Component/Form/Form.rst
Normal file
74
.doc/UI/source/generated/Component/Form/Form.rst
Normal 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
|
||||
@@ -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
|
||||
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
|
||||
94
.doc/UI/source/generated/Component/Input/Select/Select.rst
Normal file
94
.doc/UI/source/generated/Component/Input/Select/Select.rst
Normal 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
|
||||
@@ -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
|
||||
190
.doc/UI/source/generated/Component/Panel/Panel.rst
Normal file
190
.doc/UI/source/generated/Component/Panel/Panel.rst
Normal file
@@ -0,0 +1,190 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Panel
|
||||
=====
|
||||
|
||||
Class Panel
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Panel/PanelAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIPanel**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIPanel Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIPanel %}
|
||||
|
||||
:Type:
|
||||
|
||||
+----------------------------+---------------------------------------------------------------+
|
||||
| Neutral | Make a basis Panel component |
|
||||
+----------------------------+---------------------------------------------------------------+
|
||||
| ForInformation | Make a Panel component for informational messages |
|
||||
+----------------------------+---------------------------------------------------------------+
|
||||
| ForSuccess | Make a Panel component for successful messages |
|
||||
+----------------------------+---------------------------------------------------------------+
|
||||
| ForWarning | Make a Panel component for warning messages |
|
||||
+----------------------------+---------------------------------------------------------------+
|
||||
| ForDanger | Make a Panel component for danger messages |
|
||||
+----------------------------+---------------------------------------------------------------+
|
||||
| ForFailure | Make a Panel component for failure messages |
|
||||
+----------------------------+---------------------------------------------------------------+
|
||||
| WithBrandingPrimaryColor | Make a Panel component with primary color scheme |
|
||||
+----------------------------+---------------------------------------------------------------+
|
||||
| WithBrandingSecondaryColor | Make a Panel component with secondary color scheme |
|
||||
+----------------------------+---------------------------------------------------------------+
|
||||
| ForClass | Make a Panel component with the specific $sClass color scheme |
|
||||
+----------------------------+---------------------------------------------------------------+
|
||||
|
||||
:Panel *Neutral* parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
:Panel *ForInformation* parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
:Panel *ForSuccess* parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
:Panel *ForWarning* parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
:Panel *ForDanger* parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
:Panel *ForFailure* parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
:Panel *WithBrandingPrimaryColor* parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
:Panel *WithBrandingSecondaryColor* parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
:Panel *ForClass* parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--------------------------------------+
|
||||
| sClass | string | mandatory | | Class of the object the panel is for |
|
||||
+-----------+--------+-----------+------+--------------------------------------+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--------------------------------------+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--------------------------------------+
|
||||
|
||||
:Panel common parameters:
|
||||
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddCSSClass | string | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddMainBlock | iUIBlock | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddMainBlocks | array | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | directly in the main area |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddSubTitleBlock | iUIBlock | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddSubTitleBlocks | array | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddTitleBlock | iUIBlock | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddTitleBlocks | array | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddToolbarBlock | iUIBlock | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| AddToolbarBlocks | array | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| Color | string | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| ColorFromClass | string | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| ColorFromOrmStyle | ormStyle | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| DataAttributes | array | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| IsCollapsible | bool | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| MainBlocks | array | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| SubTitle | string | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| SubTitleBlock | iUIContentBlock | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| Title | string | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| TitleBlock | iUIContentBlock | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
| ToolBlocks | array | |
|
||||
+-------------------+-----------------+--------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Panel/PanelFooter.rst
|
||||
60
.doc/UI/source/generated/Component/Spinner/Spinner.rst
Normal file
60
.doc/UI/source/generated/Component/Spinner/Spinner.rst
Normal file
@@ -0,0 +1,60 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Spinner
|
||||
=======
|
||||
|
||||
Class Spinner
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Spinner/SpinnerAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UISpinner**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UISpinner Type {Parameters} %}
|
||||
|
||||
:Type:
|
||||
|
||||
+----------+------------+
|
||||
| Standard | No comment |
|
||||
+----------+------------+
|
||||
|
||||
:Spinner *Standard* parameters:
|
||||
|
||||
+-----+--------+----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----+--------+----------+------+--+
|
||||
|
||||
:Spinner 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 | |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Spinner/SpinnerFooter.rst
|
||||
112
.doc/UI/source/generated/Component/Title/Title.rst
Normal file
112
.doc/UI/source/generated/Component/Title/Title.rst
Normal file
@@ -0,0 +1,112 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Title
|
||||
=====
|
||||
|
||||
Class Title
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Title/TitleAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UITitle**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UITitle Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUITitle %}
|
||||
|
||||
:Type:
|
||||
|
||||
+-----------------+------------+
|
||||
| ForPage | No comment |
|
||||
+-----------------+------------+
|
||||
| ForPageWithIcon | No comment |
|
||||
+-----------------+------------+
|
||||
| Neutral | No comment |
|
||||
+-----------------+------------+
|
||||
| Standard | No comment |
|
||||
+-----------------+------------+
|
||||
|
||||
:Title *ForPage* parameters:
|
||||
|
||||
+--------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+--------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+--------+-----------+------+--+
|
||||
|
||||
:Title *ForPageWithIcon* parameters:
|
||||
|
||||
+------------------+--------+-----------+-----------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+------------------+--------+-----------+-----------+--+
|
||||
| sIconUrl | string | mandatory | | |
|
||||
+------------------+--------+-----------+-----------+--+
|
||||
| sIconCoverMethod | string | optional | 'contain' | |
|
||||
+------------------+--------+-----------+-----------+--+
|
||||
| bIsMedallion | bool | optional | true | |
|
||||
+------------------+--------+-----------+-----------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+------------------+--------+-----------+-----------+--+
|
||||
|
||||
:Title *Neutral* parameters:
|
||||
|
||||
+--------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+--------+--------+-----------+------+--+
|
||||
| iLevel | int | optional | 1 | |
|
||||
+--------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+--------+-----------+------+--+
|
||||
|
||||
:Title *Standard* parameters:
|
||||
|
||||
+--------+---------+-----------+------+--+
|
||||
| oTitle | UIBlock | mandatory | | |
|
||||
+--------+---------+-----------+------+--+
|
||||
| iLevel | int | optional | 1 | |
|
||||
+--------+---------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+---------+-----------+------+--+
|
||||
|
||||
:Title common parameters:
|
||||
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| 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 | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Title/TitleFooter.rst
|
||||
90
.doc/UI/source/generated/Component/Toolbar/Toolbar.rst
Normal file
90
.doc/UI/source/generated/Component/Toolbar/Toolbar.rst
Normal file
@@ -0,0 +1,90 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Toolbar
|
||||
=======
|
||||
|
||||
Class Toolbar
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Toolbar/ToolbarAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIToolbar**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIToolbar Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIToolbar %}
|
||||
|
||||
:Type:
|
||||
|
||||
+-----------+------------+
|
||||
| ForAction | No comment |
|
||||
+-----------+------------+
|
||||
| Standard | No comment |
|
||||
+-----------+------------+
|
||||
| ForButton | No comment |
|
||||
+-----------+------------+
|
||||
|
||||
:Toolbar *ForAction* parameters:
|
||||
|
||||
+-----+--------+----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----+--------+----------+------+--+
|
||||
|
||||
:Toolbar *Standard* parameters:
|
||||
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| aContainerClasses | array | optional | array () | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
|
||||
:Toolbar *ForButton* parameters:
|
||||
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| aContainerClasses | array | optional | array () | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
|
||||
:Toolbar common parameters:
|
||||
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| 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 | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Toolbar/ToolbarFooter.rst
|
||||
@@ -0,0 +1,60 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
ToolbarSpacer
|
||||
=============
|
||||
|
||||
Class ButtonToolbarSpacer
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacerAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIToolbarSpacer**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIToolbarSpacer Type {Parameters} %}
|
||||
|
||||
:Type:
|
||||
|
||||
+----------+-------------------------+
|
||||
| Standard | @param string|null $sId |
|
||||
+----------+-------------------------+
|
||||
|
||||
:ToolbarSpacer *Standard* parameters:
|
||||
|
||||
+-----+--------+----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----+--------+----------+------+--+
|
||||
|
||||
:ToolbarSpacer 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 | |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-------------------+--------+--------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacerFooter.rst
|
||||
Reference in New Issue
Block a user