mirror of
https://github.com/Combodo/iTop.git
synced 2026-04-23 18:48:51 +02:00
142 lines
6.4 KiB
ReStructuredText
142 lines
6.4 KiB
ReStructuredText
.. Copyright (C) 2010-2022 Combodo SARL
|
|
.. http://opensource.org/licenses/AGPL-3.0
|
|
|
|
.. _UIContentBlock:
|
|
|
|
UIContentBlock
|
|
==============
|
|
|
|
Class UIContentBlock
|
|
Base block containing sub-blocks
|
|
|
|
----
|
|
|
|
.. include:: /manual/Layout/UIContentBlockAdditionalDescription.rst
|
|
|
|
----
|
|
|
|
Twig Tag
|
|
--------
|
|
|
|
:Tag: **UIContentBlock**
|
|
|
|
:Syntax:
|
|
|
|
.. code-block:: twig
|
|
|
|
{% UIContentBlock Type {Parameters} %}
|
|
Content Goes Here
|
|
{% EndUIContentBlock %}
|
|
|
|
:Type:
|
|
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Standard <UIContentBlockStandard>` | Make an empty UIContentBlock which can be used to embed anything or to surround another block with specific CSS classes. |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`ForCode <UIContentBlockForCode>` | Used to display a block of code like <pre> but allows line break. |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`ForPreformatted <UIContentBlockForPreformatted>` | Used to display a block of preformatted text in a <pre> tag. |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
.. _UIContentBlockStandard:
|
|
|
|
UIContentBlock Standard
|
|
^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
:syntax:
|
|
|
|
.. code-block:: twig
|
|
|
|
{% UIContentBlock Standard {sId:'value', aContainerClasses:{name:value, name:value}} %}
|
|
Content Goes Here
|
|
{% EndUIContentBlock %}
|
|
|
|
:parameters:
|
|
|
|
+-------------------+--------+----------+----------+--+
|
|
| sId | string | optional | NULL | |
|
|
+-------------------+--------+----------+----------+--+
|
|
| aContainerClasses | array | optional | array () | |
|
|
+-------------------+--------+----------+----------+--+
|
|
|
|
.. _UIContentBlockForCode:
|
|
|
|
UIContentBlock ForCode
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
:syntax:
|
|
|
|
.. code-block:: twig
|
|
|
|
{% UIContentBlock ForCode {sCode:'value', sId:'value'} %}
|
|
Content Goes Here
|
|
{% EndUIContentBlock %}
|
|
|
|
:parameters:
|
|
|
|
+-------+--------+-----------+------+--+
|
|
| sCode | string | mandatory | | |
|
|
+-------+--------+-----------+------+--+
|
|
| sId | string | optional | NULL | |
|
|
+-------+--------+-----------+------+--+
|
|
|
|
.. _UIContentBlockForPreformatted:
|
|
|
|
UIContentBlock ForPreformatted
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
:syntax:
|
|
|
|
.. code-block:: twig
|
|
|
|
{% UIContentBlock ForPreformatted {sCode:'value', sId:'value'} %}
|
|
Content Goes Here
|
|
{% EndUIContentBlock %}
|
|
|
|
:parameters:
|
|
|
|
+-------+--------+-----------+------+--+
|
|
| sCode | string | mandatory | | |
|
|
+-------+--------+-----------+------+--+
|
|
| sId | string | optional | NULL | |
|
|
+-------+--------+-----------+------+--+
|
|
|
|
UIContentBlock common parameters
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddCSSClass | string | CSS class to add to the generated html block |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddCssFileRelPath | string | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddDeferredBlock | iUIBlock | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddHtml | string | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddJsFileRelPath | string | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddMultipleCssFilesRelPaths | array | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddMultipleJsFilesRelPaths | array | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddSubBlock | iUIBlock | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| DeferredBlocks | array | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| HasForcedDiv | bool | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| IsHidden | bool | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| SubBlocks | array | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
|
|
----
|
|
|
|
.. include:: /manual/Layout/UIContentBlockFooter.rst
|