composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-29 21:48:45 +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 17:28:12 +02:00
parent f90799d046
commit 33bd83d680
92 changed files with 3145 additions and 807 deletions
Download Patch File Download Diff File Expand all files Collapse all files

171
.doc/UI/source/generated/Component/Alert/Alert.rst Normal file
View 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