composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-30 14:08:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

FAF: Documentation UI Twig Blocks

Browse Source
This commit is contained in:
Eric
2021-05-28 18:08:15 +02:00
parent 185b927a9c
commit 541231ee5e
21 changed files with 646 additions and 644 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
.doc/UI/source/generated/Component/Alert/Alert.rst
View File

@@ -49,27 +49,27 @@ Twig Tag
:Alert *Neutral* parameters:
+----------+--------+----------+------+-------------------------------------------------+
| sTitle | string | optional | '' | |
| sTitle | string | optional | '' | Title of the alert |
+----------+--------+----------+------+-------------------------------------------------+
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
+----------+--------+----------+------+-------------------------------------------------+
| sId | string | optional | NULL | |
| sId | string | optional | NULL | id of the html block |
+----------+--------+----------+------+-------------------------------------------------+
:Alert *ForInformation* parameters:
+----------+--------+----------+------+-------------------------------------------------+
| sTitle | string | optional | '' | |
| sTitle | string | optional | '' | Title of the alert |
+----------+--------+----------+------+-------------------------------------------------+
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
+----------+--------+----------+------+-------------------------------------------------+
| sId | string | optional | NULL | |
| sId | string | optional | NULL | id of the html block |
+----------+--------+----------+------+-------------------------------------------------+
:Alert *ForSuccess* parameters:
+----------+--------+----------+------+-------------------------------------------------+
| sTitle | string | optional | '' | |
| sTitle | string | optional | '' | Title of the alert |
+----------+--------+----------+------+-------------------------------------------------+
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
+----------+--------+----------+------+-------------------------------------------------+
@@ -79,92 +79,92 @@ Twig Tag
:Alert *ForWarning* parameters:
+----------+--------+----------+------+-------------------------------------------------+
| sTitle | string | optional | '' | |
| sTitle | string | optional | '' | Title of the alert |
+----------+--------+----------+------+-------------------------------------------------+
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
+----------+--------+----------+------+-------------------------------------------------+
| sId | string | optional | NULL | |
| sId | string | optional | NULL | id of the html block |
+----------+--------+----------+------+-------------------------------------------------+
:Alert *ForDanger* parameters:
+----------+--------+----------+------+-------------------------------------------------+
| sTitle | string | optional | '' | |
| sTitle | string | optional | '' | Title of the alert |
+----------+--------+----------+------+-------------------------------------------------+
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
+----------+--------+----------+------+-------------------------------------------------+
| sId | string | optional | NULL | |
| sId | string | optional | NULL | id of the html block |
+----------+--------+----------+------+-------------------------------------------------+
:Alert *ForFailure* parameters:
+----------+--------+----------+------+-------------------------------------------------+
| sTitle | string | optional | '' | |
| sTitle | string | optional | '' | Title of the alert |
+----------+--------+----------+------+-------------------------------------------------+
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
+----------+--------+----------+------+-------------------------------------------------+
| sId | string | optional | NULL | |
| sId | string | optional | NULL | id of the html block |
+----------+--------+----------+------+-------------------------------------------------+
:Alert *WithBrandingPrimaryColor* parameters:
+----------+--------+----------+------+-------------------------------------------------+
| sTitle | string | optional | '' | |
| sTitle | string | optional | '' | Title of the alert |
+----------+--------+----------+------+-------------------------------------------------+
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
+----------+--------+----------+------+-------------------------------------------------+
| sId | string | optional | NULL | |
| sId | string | optional | NULL | id of the html block |
+----------+--------+----------+------+-------------------------------------------------+
:Alert *WithBrandingSecondaryColor* parameters:
+----------+--------+----------+------+-------------------------------------------------+
| sTitle | string | optional | '' | |
| sTitle | string | optional | '' | Title of the alert |
+----------+--------+----------+------+-------------------------------------------------+
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
+----------+--------+----------+------+-------------------------------------------------+
| sId | string | optional | NULL | |
| sId | string | optional | NULL | id of the html block |
+----------+--------+----------+------+-------------------------------------------------+
: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 | |
+-------------------+----------+--------------------------------------------------------+
+-------------------+----------+------------------------------------------------------------------------+
| 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 | |
+-------------------+----------+------------------------------------------------------------------------+
| AddSubBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------------------+
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+------------------------------------------------------------------------+
| Color | string | Color of the alert (check CSS classes ibo-is-<color> for colors) |
+-------------------+----------+------------------------------------------------------------------------+
| Content | string | The raw HTML content, must be already sanitized |
+-------------------+----------+------------------------------------------------------------------------+
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
+-------------------+----------+------------------------------------------------------------------------+
| DeferredBlocks | array | |
+-------------------+----------+------------------------------------------------------------------------+
| IsClosable | bool | Indicates if the user can remove the alert from the screen |
+-------------------+----------+------------------------------------------------------------------------+
| IsCollapsible | bool | Indicates if the user can collapse the alert to display only the title |
+-------------------+----------+------------------------------------------------------------------------+
| IsHidden | bool | Indicates if the block is hidden by default |
+-------------------+----------+------------------------------------------------------------------------+
| OpenedByDefault | bool | Indicates if the alert is collapsed or not by default |
+-------------------+----------+------------------------------------------------------------------------+
| SubBlocks | array | |
+-------------------+----------+------------------------------------------------------------------------+
| Title | string | Title of the alert |
+-------------------+----------+------------------------------------------------------------------------+
----