mirror of
https://github.com/Combodo/iTop.git
synced 2026-04-26 20:18:52 +02:00
FAF: Documentation UI Twig Blocks - HTML result
This commit is contained in:
@@ -0,0 +1,88 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _ButtonGroup:
|
||||
|
||||
ButtonGroup
|
||||
===========
|
||||
|
||||
Class ButtonGroup
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/ButtonGroup/ButtonGroupAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIButtonGroup**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButtonGroup Type {Parameters} %}
|
||||
|
||||
:Type:
|
||||
|
||||
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ButtonWithOptionsMenu <ButtonGroupButtonWithOptionsMenu>` | Make a button that has a primary action ($oButton) but also an options menu ($oMenu) on the side |
|
||||
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _ButtonGroupButtonWithOptionsMenu:
|
||||
|
||||
ButtonGroup ButtonWithOptionsMenu
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButtonGroup ButtonWithOptionsMenu {oButton:value, oMenu:value} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+---------+-------------+-----------+--+--+
|
||||
| oButton | Button | mandatory | | |
|
||||
+---------+-------------+-----------+--+--+
|
||||
| oMenu | PopoverMenu | mandatory | | |
|
||||
+---------+-------------+-----------+--+--+
|
||||
|
||||
ButtonGroup common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddButton | Button | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddButtons | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddExtraBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| Buttons | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | Indicates if the block is hidden by default |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/ButtonGroup/ButtonGroupFooter.rst
|
||||
Reference in New Issue
Block a user