mirror of
https://github.com/Combodo/iTop.git
synced 2026-04-21 17:48:43 +02:00
FAF: Documentation UI Twig Blocks
This commit is contained in:
Eric
374
.doc/UI/bin/generate_uiblock.php
Normal file
374
.doc/UI/bin/generate_uiblock.php
Normal file
@@ -0,0 +1,374 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (C) 2010-2021 Combodo SARL
|
||||
* @license http://opensource.org/licenses/AGPL-3.0
|
||||
*/
|
||||
|
||||
namespace Combodo\iTop\Documentation\UI;
|
||||
|
||||
use Exception;
|
||||
use ReflectionClass;
|
||||
use ReflectionMethod;
|
||||
use ReflectionNamedType;
|
||||
use utils;
|
||||
|
||||
chdir(__DIR__);
|
||||
|
||||
require_once '../../../approot.inc.php';
|
||||
require_once(APPROOT.'application/startup.inc.php');
|
||||
|
||||
function log($sMsg)
|
||||
{
|
||||
$sDate = date('Y-m-d H:i:s');
|
||||
echo "{$sDate} - {$sMsg}\n";
|
||||
}
|
||||
|
||||
function DisplayParamsArray(array $aParams, array $aColumns)
|
||||
{
|
||||
foreach ($aParams as $aParam) {
|
||||
foreach ($aColumns as $sColName => $iMax) {
|
||||
$iLen = strlen($aParam[$sColName]);
|
||||
if ($iLen > $iMax) {
|
||||
$aColumns[$sColName] = $iLen;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$sArrayLine = '+';
|
||||
foreach ($aColumns as $iMax) {
|
||||
$sArrayLine .= str_repeat('-', $iMax + 2).'+';
|
||||
}
|
||||
echo "$sArrayLine\n";
|
||||
foreach ($aParams as $aParam) {
|
||||
foreach ($aColumns as $sColName => $iMax) {
|
||||
echo '| '.str_pad($aParam[$sColName], $iMax).' ';
|
||||
}
|
||||
echo "|\n";
|
||||
echo "$sArrayLine\n";
|
||||
}
|
||||
echo "\n";
|
||||
}
|
||||
|
||||
function output(string $sClass, string $sClassComment, string $sDir, string $sTag, bool $bHasSubBlocks, array $aDocTypes, array $aDocGeneralParams)
|
||||
{
|
||||
if ($bHasSubBlocks) {
|
||||
$sSyntax = <<<EOF
|
||||
{% $sTag Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% End$sTag %}
|
||||
EOF;
|
||||
} else {
|
||||
$sSyntax = <<<EOF
|
||||
{% $sTag Type {Parameters} %}
|
||||
EOF;
|
||||
}
|
||||
|
||||
|
||||
echo ".. Copyright (C) 2010-2021 Combodo SARL\n";
|
||||
echo ".. http://opensource.org/licenses/AGPL-3.0\n";
|
||||
echo "\n";
|
||||
echo "$sClass\n";
|
||||
$sLine = str_repeat('=', strlen($sClass));
|
||||
echo "$sLine\n";
|
||||
echo "\n";
|
||||
echo "$sClassComment\n";
|
||||
echo "\n";
|
||||
echo "----\n";
|
||||
echo "\n";
|
||||
echo ".. include:: /manual/{$sDir}AdditionalDescription.rst\n";
|
||||
echo "\n";
|
||||
echo "----\n";
|
||||
echo "\n";
|
||||
echo "Twig Tag\n";
|
||||
echo "--------\n";
|
||||
echo "\n";
|
||||
echo ":Tag: **$sTag**\n";
|
||||
echo "\n";
|
||||
echo ":Syntax:\n";
|
||||
echo " \n";
|
||||
echo "::\n";
|
||||
echo "\n";
|
||||
echo "$sSyntax\n";
|
||||
echo "\n";
|
||||
echo ":Type:\n";
|
||||
echo "\n";
|
||||
$iMaxLength = 0;
|
||||
$iMaxComLength = 0;
|
||||
foreach ($aDocTypes as $sType => $aDoc) {
|
||||
$sComment = $aDoc['comment'];
|
||||
$iLength = strlen($sType);
|
||||
if ($iLength > $iMaxLength) {
|
||||
$iMaxLength = $iLength;
|
||||
}
|
||||
$iComLength = strlen($sComment);
|
||||
if ($iComLength > $iMaxComLength) {
|
||||
$iMaxComLength = $iComLength;
|
||||
}
|
||||
}
|
||||
$sArrayLine = '+'.str_repeat('-', $iMaxLength + 2).'+'.str_repeat('-', $iMaxComLength + 2).'+';
|
||||
echo "$sArrayLine\n";
|
||||
foreach ($aDocTypes as $sType => $aDoc) {
|
||||
$sComment = $aDoc['comment'];
|
||||
echo '| '.str_pad($sType, $iMaxLength).' | '.str_pad($sComment, $iMaxComLength)." |\n";
|
||||
echo "$sArrayLine\n";
|
||||
}
|
||||
echo "\n";
|
||||
|
||||
// Parameters for each type
|
||||
foreach ($aDocTypes as $sType => $aDoc) {
|
||||
$aParams = $aDoc['params'];
|
||||
if (!empty($aParams)) {
|
||||
echo ":$sClass *$sType* parameters:\n";
|
||||
echo "\n";
|
||||
$aColumns = [
|
||||
'name' => 0,
|
||||
'type' => 0,
|
||||
'status' => 0,
|
||||
'default' => 0,
|
||||
'comment' => 0,
|
||||
];
|
||||
DisplayParamsArray($aParams, $aColumns);
|
||||
}
|
||||
}
|
||||
|
||||
if (!empty($aDocGeneralParams)) {
|
||||
echo ":$sClass common parameters:\n";
|
||||
echo "\n";
|
||||
$aColumns = [
|
||||
'name' => 0,
|
||||
'type' => 0,
|
||||
'comment' => 0,
|
||||
];
|
||||
usort($aDocGeneralParams, function ($a, $b) {
|
||||
return strcmp($a['name'], $b['name']);
|
||||
});
|
||||
DisplayParamsArray($aDocGeneralParams, $aColumns);
|
||||
}
|
||||
|
||||
echo "----\n";
|
||||
echo "\n";
|
||||
echo ".. include:: /manual/{$sDir}Footer.rst\n";
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @param \ReflectionMethod $oMethod
|
||||
* @param string $sFullComment
|
||||
*
|
||||
* @return array
|
||||
* @throws \ReflectionException
|
||||
*/
|
||||
function GetMethodParameters(ReflectionMethod $oMethod, string $sFullComment): array
|
||||
{
|
||||
$aDocParams = [];
|
||||
$aParameters = $oMethod->getParameters();
|
||||
foreach ($aParameters as $oParameter) {
|
||||
$sName = $oParameter->getName();
|
||||
$aDocParam['name'] = $sName;
|
||||
if ($oParameter->isOptional()) {
|
||||
$aDocParam['status'] = 'optional';
|
||||
$sDefault = $oParameter->getDefaultValue();
|
||||
$aDocParam['default'] = str_replace("\n", '', var_export($sDefault, true));
|
||||
} else {
|
||||
$aDocParam['status'] = 'mandatory';
|
||||
$aDocParam['default'] = '';
|
||||
}
|
||||
|
||||
$oParamType = $oParameter->getType();
|
||||
if ($oParamType instanceof ReflectionNamedType) {
|
||||
$sType = $oParamType->getName();
|
||||
$iPos = strrpos($sType, "\\");
|
||||
if ($iPos !== false) {
|
||||
$sType = substr($sType, $iPos + 1);
|
||||
}
|
||||
$aDocParam['type'] = $sType;
|
||||
} else {
|
||||
$aDocParam['type'] = '';
|
||||
}
|
||||
|
||||
if ($sFullComment !== false) {
|
||||
$sComment = $sFullComment;
|
||||
$iPos = strpos($sComment, $sName);
|
||||
if ($iPos !== false) {
|
||||
$sComment = substr($sComment, strpos($sComment, '@param'));
|
||||
$iPos = strpos($sComment, $sName);
|
||||
$sComment = substr($sComment, $iPos + strlen($sName));
|
||||
$sComment = substr($sComment, 0, strpos($sComment, "\n"));
|
||||
$sComment = trim($sComment);
|
||||
} else {
|
||||
$sComment = '';
|
||||
}
|
||||
} else {
|
||||
$sComment = '';
|
||||
}
|
||||
$aDocParam['comment'] = $sComment;
|
||||
$aDocParams[] = $aDocParam;
|
||||
}
|
||||
|
||||
return $aDocParams;
|
||||
}
|
||||
|
||||
/////////////////////////////
|
||||
/// Main
|
||||
///
|
||||
|
||||
if (!utils::IsModeCLI()) {
|
||||
\Combodo\iTop\FullTextSearch\log("Only CLI mode is allowed");
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$sUIBlock = utils::ReadParam('uiblock', '', true);
|
||||
|
||||
$sSourceDir = '../source';
|
||||
|
||||
$sInterface = "Combodo\\iTop\\Application\\UI\\Base\\iUIBlockFactory";
|
||||
$aFactoryClasses = utils::GetClassesForInterface($sInterface, $sUIBlock.'UIBlockFactory');
|
||||
|
||||
|
||||
foreach ($aFactoryClasses as $sFactoryClass) {
|
||||
try {
|
||||
$sTag = call_user_func([$sFactoryClass, 'GetTwigTagName']);
|
||||
$sBlockClassName = call_user_func([$sFactoryClass, 'GetUIBlockClassName']);
|
||||
$bHasSubBlocks = is_subclass_of($sBlockClassName, "Combodo\\iTop\\Application\\UI\\Base\\Layout\\UIContentBlock") || $sBlockClassName == "Combodo\\iTop\\Application\\UI\\Base\\Layout\\UIContentBlock";
|
||||
|
||||
$oReflectionClassFactory = new ReflectionClass($sFactoryClass);
|
||||
$oReflectionClassUIBlock = new ReflectionClass($sBlockClassName);
|
||||
$sClassName = $oReflectionClassUIBlock->getShortName();
|
||||
|
||||
$aMethods = $oReflectionClassFactory->getMethods(ReflectionMethod::IS_PUBLIC);
|
||||
|
||||
$aDocTypes = [];
|
||||
foreach ($aMethods as $oMethod) {
|
||||
$sMethodName = $oMethod->name;
|
||||
if (utils::StartsWith($sMethodName, 'Make')) {
|
||||
$oMethod = $oReflectionClassFactory->getMethod($sMethodName);
|
||||
$sFullComment = $oMethod->getDocComment();
|
||||
if ($sFullComment !== false) {
|
||||
// Remove the first line
|
||||
$sComment = $sFullComment;
|
||||
$sComment = substr($sComment, strpos($sComment, "\n") + 1);
|
||||
$sComment = trim(substr($sComment, strpos($sComment, "*") + 1));
|
||||
// Remove the last lines
|
||||
$sComment = substr($sComment, 0, strpos($sComment, "\n"));
|
||||
} else {
|
||||
$sComment = 'No comment';
|
||||
}
|
||||
$sType = substr($sMethodName, strlen('Make'));
|
||||
$aDocType['comment'] = $sComment;
|
||||
|
||||
$aDocType['params'] = GetMethodParameters($oMethod, $sFullComment);
|
||||
$aDocTypes[$sType] = $aDocType;
|
||||
}
|
||||
}
|
||||
|
||||
// Setters and Adders
|
||||
$aMethods = $oReflectionClassUIBlock->getMethods(ReflectionMethod::IS_PUBLIC);
|
||||
$aDocGeneralParams = [];
|
||||
foreach ($aMethods as $oMethod) {
|
||||
if (!$oMethod->isStatic() && $oMethod->getNumberOfParameters() == 1) {
|
||||
$sName = '';
|
||||
if (utils::StartsWith($oMethod->getName(), 'Set')) {
|
||||
$sName = substr($oMethod->getName(), 3); // remove 'Set' to get the variable name
|
||||
}
|
||||
if (utils::StartsWith($oMethod->getName(), 'Add')) {
|
||||
$sName = $oMethod->getName();
|
||||
}
|
||||
if (!empty($sName)) {
|
||||
$sFullComment = $oMethod->getDocComment();
|
||||
$aParams = GetMethodParameters($oMethod, $sFullComment)[0];
|
||||
$aParams['name'] = $sName;
|
||||
$aDocGeneralParams[] = $aParams;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Class comment
|
||||
$sFullClassComment = $oReflectionClassUIBlock->getDocComment();
|
||||
$aComments = preg_split("@\n@", $sFullClassComment);
|
||||
$aClassComments = [];
|
||||
// remove first line
|
||||
array_shift($aComments);
|
||||
while ($sComment = array_shift($aComments)) {
|
||||
if (utils::StartsWith($sComment, " * @")) {
|
||||
break;
|
||||
}
|
||||
$sComment = trim(preg_replace("@^ \*@", '', $sComment));
|
||||
if (strlen($sComment) > 0) {
|
||||
$aClassComments[] = $sComment;
|
||||
}
|
||||
}
|
||||
|
||||
$sClassComment = implode("\n", $aClassComments);
|
||||
|
||||
if (empty($sClassComment)) {
|
||||
$sClassComment = "Class $sClassName";
|
||||
}
|
||||
|
||||
$sDir = str_replace("Combodo\\iTop\\Application\\UI\\Base\\", '', $sBlockClassName);
|
||||
$sDir = str_replace("\\", '/', $sDir);
|
||||
|
||||
ob_start();
|
||||
output($sClassName, $sClassComment, $sDir, $sTag, $bHasSubBlocks, $aDocTypes, $aDocGeneralParams);
|
||||
$sContent = ob_get_contents();
|
||||
ob_end_clean();
|
||||
|
||||
$sFilename = $sSourceDir.'/generated/'.$sDir.'.rst';
|
||||
@mkdir(dirname($sFilename), 0775, true);
|
||||
file_put_contents($sFilename, $sContent);
|
||||
|
||||
// Check that manual files exists
|
||||
$sAdditionalDescription = $sSourceDir.'/manual/'.$sDir.'AdditionalDescription.rst';
|
||||
@mkdir(dirname($sAdditionalDescription), 0775, true);
|
||||
if (!is_file($sAdditionalDescription)) {
|
||||
file_put_contents($sAdditionalDescription, <<<EOF
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/$sDir.png
|
||||
|
||||
|
||||
EOF
|
||||
);
|
||||
}
|
||||
$sFooter = $sSourceDir.'/manual/'.$sDir.'Footer.rst';
|
||||
@mkdir(dirname($sFooter), 0775, true);
|
||||
if (!is_file($sFooter)) {
|
||||
file_put_contents($sFooter, <<<EOF
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/$sDir.png
|
||||
|
||||
EOF
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
echo "Generated $sFilename\n";
|
||||
}
|
||||
catch (Exception $e) {
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
// Rebuild doc
|
||||
$sRootDir = dirname(__DIR__);
|
||||
shell_exec("$sRootDir/make.bat html");
|
||||
|
||||
|
||||
|
||||
@@ -1,76 +0,0 @@
|
||||
.. 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.
|
||||
|
||||
----
|
||||
|
||||
Output Result
|
||||
-------------
|
||||
|
||||
.. include:: OutputExamples.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIAlert**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIAlert Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIAlert %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *ForSuccess* | Create a *Success Alert* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *ForInformation* | Create an *Information Alert* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *ForWarning* | Create an *Warning Alert* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *ForFailure* | Create an *Failure Alert* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *ForDanger* | Create an *Danger Alert* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *Neutral* | Create an *Basis Alert* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *WithBrandingPrimaryColor* | Create an alert having the branding primary color |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *WithBrandingSecondaryColor* | Create an alert having the branding secondary color |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
|
||||
:Alert common parameters:
|
||||
|
||||
+-------------------+--------+----------+----------------------------------+
|
||||
| *sTiTle* | string | optional | Title of the alert |
|
||||
+-------------------+--------+----------+----------------------------------+
|
||||
| *sContent* | string | optional | Collapsible content of the alert |
|
||||
+-------------------+--------+----------+----------------------------------+
|
||||
| *sId* | string | optional | ID of the HTML block |
|
||||
+-------------------+--------+----------+----------------------------------+
|
||||
| *IsCollapsible* | bool | optional | can be collapsed or not |
|
||||
+-------------------+--------+----------+----------------------------------+
|
||||
| *IsClosable* | bool | optional | can be closed or not |
|
||||
+-------------------+--------+----------+----------------------------------+
|
||||
| *OpenedByDefault* | bool | optional | Opened or not |
|
||||
+-------------------+--------+----------+----------------------------------+
|
||||
|
||||
:See also: :ref:`UIBlock Common parameters <UIBlock_parameters>`
|
||||
|
||||
----
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
.. include:: Examples.rst
|
||||
@@ -1,19 +0,0 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
:Success Alert:
|
||||
|
||||
.. image:: AlertSuccess.png
|
||||
|
||||
:Failure Alert:
|
||||
|
||||
.. image:: AlertFailure.png
|
||||
|
||||
:Information Alert:
|
||||
|
||||
.. image:: AlertInformation.png
|
||||
|
||||
:Warning Alert:
|
||||
|
||||
.. image:: AlertWarning.png
|
||||
@@ -1,57 +0,0 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Button
|
||||
======
|
||||
|
||||
*In Progress*
|
||||
|
||||
----
|
||||
|
||||
Output Result
|
||||
-------------
|
||||
|
||||
:Example Buttons:
|
||||
|
||||
.. image:: Button-all.png
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIButton**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIButton Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIButton %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *Standard* | Create a *Default Button* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
|
||||
:Button common parameters:
|
||||
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sId* | string | optional | ID of the HTML block |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
|
||||
:See also: :ref:`UIBlock Common parameters <UIBlock_parameters>`
|
||||
|
||||
----
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Example to generate a button::
|
||||
|
||||
{% UIButton Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIButton %}
|
||||
|
||||
@@ -1,56 +0,0 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
ButtonGroup
|
||||
===========
|
||||
|
||||
*In Progress*
|
||||
|
||||
----
|
||||
|
||||
Output Result
|
||||
-------------
|
||||
|
||||
:Example ButtonGroups:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIButtonGroup**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIButtonGroup Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIButtonGroup %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *Standard* | Create a *Default ButtonGroup* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
|
||||
:ButtonGroup common parameters:
|
||||
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sId* | string | optional | ID of the HTML block |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
|
||||
:See also: :ref:`UIBlock Common parameters <UIBlock_parameters>`
|
||||
|
||||
----
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Example to generate a ButtonGroup::
|
||||
|
||||
{% UIButtonGroup Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIButtonGroup %}
|
||||
|
||||
@@ -1,56 +0,0 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
CollapsibleSection
|
||||
==================
|
||||
|
||||
*In Progress*
|
||||
|
||||
----
|
||||
|
||||
Output Result
|
||||
-------------
|
||||
|
||||
:Example CollapsibleSections:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UICollapsibleSection**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UICollapsibleSection Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUICollapsibleSection %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *Standard* | Create a *Default CollapsibleSection* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
|
||||
:CollapsibleSection common parameters:
|
||||
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sId* | string | optional | ID of the HTML block |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
|
||||
:See also: :ref:`UIBlock Common parameters <UIBlock_parameters>`
|
||||
|
||||
----
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Example to generate a CollapsibleSection::
|
||||
|
||||
{% UICollapsibleSection Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUICollapsibleSection %}
|
||||
|
||||
@@ -1,148 +0,0 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
DataTable
|
||||
=========
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
This block is used to display data in a tabular way.
|
||||
Data can come from the database (*Dynamic DataTable*) or from a static array (*Static DataTable*).
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Dynamic DataTable
|
||||
|
||||
.. image:: Datatable.png
|
||||
|
||||
Static DataTable
|
||||
|
||||
.. image:: DatatableStatic.png
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIDataTable**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIDataTable Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIDataTable %}
|
||||
|
||||
:Type:
|
||||
|
||||
- **ForResult**
|
||||
|
||||
Create a table from search results. The data to display are given using a *DBObjectSet*.
|
||||
|
||||
|
||||
----
|
||||
|
||||
- **ForObject**
|
||||
|
||||
Create a table from search results. The data to display are given using a *DBObjectSet*.
|
||||
|
||||
----
|
||||
|
||||
- **ForRendering**
|
||||
|
||||
Create a table from search results. The data to display are given using a *DBObjectSet*.
|
||||
|
||||
|
||||
----
|
||||
|
||||
- **ForRenderingObject**
|
||||
|
||||
Create a table from search results. The data to display are given using a *DBObjectSet*.
|
||||
|
||||
|
||||
----
|
||||
|
||||
- **ForStaticData**
|
||||
|
||||
Create a table from static data.
|
||||
|
||||
:Parameters:
|
||||
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sTitle* | string | mandatory | Title of the table |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *aColumns* | array | mandatory | Array of columns |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *aData* | array | optional | Array of data |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sId* | string | optional | Id of the block |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *aExtraParams* | array | optional | Array of extra parameters |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sFilter* | string | optional | OQL filter |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *aOptions* | array | optional | Array of options |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
|
||||
|
||||
The columns (*aColumns*) have the following format:
|
||||
|
||||
::
|
||||
|
||||
[
|
||||
'nameField1' => ['label' => labelField1, 'description' => descriptionField1],
|
||||
...
|
||||
]
|
||||
|
||||
The data (*aData*) format has to be:
|
||||
|
||||
::
|
||||
|
||||
[
|
||||
['nameField1' => valueField1, 'nameField2' => valueField2, ...],
|
||||
...
|
||||
]
|
||||
|
||||
|
||||
----
|
||||
|
||||
- **ForForm**
|
||||
|
||||
Create a table from static data.
|
||||
|
||||
:Parameters:
|
||||
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sRef* | string | mandatory | Title of the table |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *aColumns* | array | mandatory | Array of columns |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *aData* | array | optional | Array of data |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sFilter* | string | optional | OQL filter |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
|
||||
:See also: :ref:`UIBlock Common parameters <UIBlock_parameters>`
|
||||
|
||||
|
||||
The columns (*aColumns*) have the following format:
|
||||
|
||||
::
|
||||
|
||||
[
|
||||
'nameField1' => ['label' => labelField1, 'description' => descriptionField1],
|
||||
...
|
||||
]
|
||||
|
||||
The data (*aData*) format has to be:
|
||||
|
||||
::
|
||||
|
||||
[
|
||||
['nameField1' => valueField1, 'nameField2' => valueField2, ...],
|
||||
...
|
||||
]
|
||||
|
||||
|
||||
|
||||
@@ -1,127 +0,0 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
.. _Field:
|
||||
|
||||
Field
|
||||
=====
|
||||
|
||||
*In Progress*
|
||||
|
||||
----
|
||||
|
||||
Output Result
|
||||
-------------
|
||||
|
||||
:Example Fields:
|
||||
|
||||
.. image:: Field.png
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIField**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIField Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIField %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *Standard* | Create a *Default FieldSet* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *Small* | Create a *FieldSet* with *small* layout |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *Large* | Create a *FieldSet* with *large* layout |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *FromParams* | Create a *FieldSet* from given parameters |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
|
||||
:Field *Standard* parameters:
|
||||
|
||||
+-------------------+--------+-----------+---------------------------------------------+
|
||||
| *sLabel* | string | optional | Label (default empty) |
|
||||
+-------------------+--------+-----------+---------------------------------------------+
|
||||
| *sLayout* | string | optional | Layout ('small' or 'large') default 'small' |
|
||||
+-------------------+--------+-----------+---------------------------------------------+
|
||||
| *sId* | string | optional | ID of the HTML block |
|
||||
+-------------------+--------+-----------+---------------------------------------------+
|
||||
|
||||
:Field *Small* and *Large* parameters:
|
||||
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sLabel* | string | Mandatory | Label |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sValueHtml* | string | optional | HTML value (default empty) |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
|
||||
:Field *FromParams* parameters:
|
||||
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *aParams* | array | Mandatory | array of parameters |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
|
||||
:*aParams* values:
|
||||
|
||||
+-------------------+--------+----------------------------------------------+
|
||||
| *layout* | string | Layout ('small' or 'large') |
|
||||
+-------------------+--------+----------------------------------------------+
|
||||
| *attcode* | string | Attribute code |
|
||||
+-------------------+--------+----------------------------------------------+
|
||||
| *atttype* | string | Attribute type |
|
||||
+-------------------+--------+----------------------------------------------+
|
||||
| *attlabel* | string | Attribute label |
|
||||
+-------------------+--------+----------------------------------------------+
|
||||
| *value_raw* | string | Attribute raw value |
|
||||
+-------------------+--------+----------------------------------------------+
|
||||
| *comments* | string | Comments (tooltip) |
|
||||
+-------------------+--------+----------------------------------------------+
|
||||
| *input_id* | string | Input id |
|
||||
+-------------------+--------+----------------------------------------------+
|
||||
| *input_type* | string | Input type |
|
||||
+-------------------+--------+----------------------------------------------+
|
||||
| *attflags* | array | Array of flags |
|
||||
+-------------------+--------+----------------------------------------------+
|
||||
|
||||
:*attflags* values:
|
||||
|
||||
+-------------------+---------+----------------------------------------------+
|
||||
| *1* | boolean | Hidden flag |
|
||||
+-------------------+---------+----------------------------------------------+
|
||||
| *2* | boolean | Read only flag |
|
||||
+-------------------+---------+----------------------------------------------+
|
||||
| *4* | boolean | Mandatory flag |
|
||||
+-------------------+---------+----------------------------------------------+
|
||||
| *8* | boolean | Must change flag |
|
||||
+-------------------+---------+----------------------------------------------+
|
||||
| *16* | boolean | Must prompt flag |
|
||||
+-------------------+---------+----------------------------------------------+
|
||||
| *32* | boolean | Slave flag |
|
||||
+-------------------+---------+----------------------------------------------+
|
||||
|
||||
|
||||
:See also: :ref:`UIBlock Common parameters <UIBlock_parameters>`
|
||||
|
||||
:Related Tag: :ref:`FieldSet <FieldSet>`
|
||||
|
||||
----
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Example to generate a Field::
|
||||
|
||||
{% UIField Small {sLabel: "Product"} %}
|
||||
iTop
|
||||
{% EndUIField %}
|
||||
|
||||
|
||||
The result:
|
||||
|
||||
.. image:: Field.png
|
||||
@@ -1,73 +0,0 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
.. _FieldSet:
|
||||
|
||||
FieldSet
|
||||
========
|
||||
|
||||
*In Progress*
|
||||
|
||||
----
|
||||
|
||||
Output Result
|
||||
-------------
|
||||
|
||||
:Example FieldSets:
|
||||
|
||||
.. image:: FieldSet.png
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIFieldSet**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIFieldSet Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIFieldSet %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *Standard* | Create a *Default FieldSet* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *Small* | Create a *FieldSet* with *small* layout |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *Large* | Create a *FieldSet* with *large* layout |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *FromParams* | Create a *FieldSet* from given parameters |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
|
||||
:FieldSet common parameters:
|
||||
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sLegend* | string | Mandatory | Displayed legend of the FieldSet |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sId* | string | optional | ID of the HTML block |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
|
||||
:See also: :ref:`UIBlock Common parameters <UIBlock_parameters>`
|
||||
|
||||
:Related Tag: :ref:`Field <Field>`
|
||||
|
||||
----
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Example to generate a FieldSet::
|
||||
|
||||
{% UIFieldSet Standard {sLegend: "iTop environment"} %}
|
||||
{% UIField ... %}
|
||||
...
|
||||
{% EndUIFieldSet %}
|
||||
|
||||
The result:
|
||||
|
||||
.. image:: FieldSet-explained.png
|
||||
|
||||
@@ -1,88 +0,0 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Title
|
||||
=====
|
||||
|
||||
Display a title.
|
||||
|
||||
----
|
||||
|
||||
Output Result
|
||||
-------------
|
||||
|
||||
.. image:: Title.png
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UITitle**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UITitle Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUITitle %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *ForPage* | Create a *page title* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *ForPageWithIcon* | Create an *page title with icon* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *Neutral* | Create an *generic title* |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
|
||||
:Title common parameters:
|
||||
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sTitle* | string | mandatory | Title |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
| *sId* | string | optional | ID of the HTML block |
|
||||
+-------------------+--------+-----------+----------------------------------+
|
||||
|
||||
:ForPageWithIcon specific parameters:
|
||||
|
||||
+--------------------+--------+-----------+------------------------------------------------+
|
||||
| *sIconUrl* | string | mandatory | Icon URL |
|
||||
+--------------------+--------+-----------+------------------------------------------------+
|
||||
| *sIconCoverMethod* | string | optional | one of *contain* (default), *zoomout*, *cover* |
|
||||
+--------------------+--------+-----------+------------------------------------------------+
|
||||
| *bIsMedallion* | bool | optional | displayed as medallion (default true) |
|
||||
+--------------------+--------+-----------+------------------------------------------------+
|
||||
|
||||
:sIconCoverMethod values:
|
||||
|
||||
- *contain*: Icon should be contained (boxed) in the medallion, best for icons with transparent background and some margin around
|
||||
- *zoomout*: Icon should be a little zoomed out to cover almost all space, best for icons with transparent background and no margin around (eg. class icons)
|
||||
- *cover*: Icon should cover all the space, best for icons with filled background
|
||||
|
||||
:Neutral specific parameters:
|
||||
|
||||
+-------------------+---------+-----------+----------------------------------+
|
||||
| *iLevel* | integer | mandatory | Title level (1-5) 1 is biggest |
|
||||
+-------------------+---------+-----------+----------------------------------+
|
||||
|
||||
|
||||
:See also: :ref:`UIBlock Common parameters <UIBlock_parameters>`
|
||||
|
||||
----
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
:The following code:
|
||||
|
||||
::
|
||||
|
||||
{% UITitle ForPage {sTitle: 'UI:FullTextSearchTitle_Text'|dict_format(sFullText)} %}{% EndUITitle %}
|
||||
|
||||
:Will display:
|
||||
|
||||
.. image:: Title.png
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
UIBlock
|
||||
=======
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
UIBlock is the root class for all the other blocks.
|
||||
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
This block has no Twig tag, but the following parameters are common to all the other Twig blocks.
|
||||
|
||||
.. _UIBlock_parameters:
|
||||
|
||||
:Parameters:
|
||||
|
||||
+------------------+--------+----------+----------------------------------------------+
|
||||
| *CSSClasses* | array | optional | Array of CSS classes to set to the block |
|
||||
+------------------+--------+----------+----------------------------------------------+
|
||||
| *DataAttributes* | array | optional | Array of data attributes to set to the block |
|
||||
+------------------+--------+----------+----------------------------------------------+
|
||||
| *IsHidden* | bool | optional | Show or hide the current block |
|
||||
+------------------+--------+----------+----------------------------------------------+
|
||||
| *AddCSSClass* | string | optional | Add a CSS class to the block |
|
||||
+------------------+--------+----------+----------------------------------------------+
|
||||
| *AddCSSClasses* | array | optional | Add CSS classes to the block |
|
||||
+------------------+--------+----------+----------------------------------------------+
|
||||
|
||||
|
||||
@@ -1,67 +0,0 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
UIContentBlock
|
||||
==============
|
||||
|
||||
Add a content block.
|
||||
|
||||
Create a ``<div>`` only if container class or data attributes are provided or is hidden.
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIContentBlock**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIContentBlock Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIContentBlock %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *Standard* | Create a default content block |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
| *ForCode* | Create a content block to display code |
|
||||
+------------------------------+-----------------------------------------------------+
|
||||
|
||||
:UIContentBlock common parameters:
|
||||
|
||||
+---------------------+--------+-----------+----------------------------------+
|
||||
| *aContainerClasses* | array | optional | array of classes |
|
||||
+---------------------+--------+-----------+----------------------------------+
|
||||
| *sId* | string | optional | ID of the HTML block |
|
||||
+---------------------+--------+-----------+----------------------------------+
|
||||
|
||||
:ForCode specific parameters:
|
||||
|
||||
+--------------------+--------+-----------+------------------------------------------------+
|
||||
| *sCode* | string | mandatory | Provided code to display |
|
||||
+--------------------+--------+-----------+------------------------------------------------+
|
||||
|
||||
|
||||
:See also: :ref:`UIBlock Common parameters <UIBlock_parameters>`
|
||||
|
||||
----
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
::
|
||||
|
||||
{% UIContentBlock Standard {aContainerClasses:["my-class", "my-other-class"], DataAttributes: {role: "my-role"}} %}
|
||||
Content Goes Here
|
||||
{% EndUIContentBlock %}
|
||||
|
||||
Will produce the following HTML::
|
||||
|
||||
<div id="ibo-content-block-60a3a9c59d4b95-40516619" class="my-class my-other-class" data-role="my-role">
|
||||
Content Goes Here
|
||||
</div>
|
||||
|
||||
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
|
||||
@@ -19,4 +19,13 @@ A UI component is a unitary block used to display information in iTop console.
|
||||
ButtonGroup/ButtonGroup
|
||||
CollapsibleSection/CollapsibleSection
|
||||
DataTable/DataTable
|
||||
UIBlock/UIBlock
|
||||
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
|
||||
@@ -10,4 +10,6 @@ A UI block that serves as a layout for the page.
|
||||
:maxdepth: 1
|
||||
:caption: Components:
|
||||
|
||||
UIContentBlock/UIContentBlock
|
||||
UIContentBlock
|
||||
MultiColumn/MultiColumn
|
||||
MultiColumn/Column/Column
|
||||
@@ -0,0 +1,80 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Column
|
||||
======
|
||||
|
||||
Class Column
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/MultiColumn/Column/ColumnAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIColumn**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIColumn Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIColumn %}
|
||||
|
||||
:Type:
|
||||
|
||||
+----------+------------+
|
||||
| Standard | No comment |
|
||||
+----------+------------+
|
||||
| ForBlock | No comment |
|
||||
+----------+------------+
|
||||
|
||||
:Column *Standard* parameters:
|
||||
|
||||
+-----+--------+----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----+--------+----------+------+--+
|
||||
|
||||
:Column *ForBlock* parameters:
|
||||
|
||||
+--------+---------+-----------+------+--+
|
||||
| oBlock | UIBlock | mandatory | | |
|
||||
+--------+---------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+---------+-----------+------+--+
|
||||
|
||||
:Column 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/Layout/MultiColumn/Column/ColumnFooter.rst
|
||||
72
.doc/UI/source/generated/Layout/MultiColumn/MultiColumn.rst
Normal file
72
.doc/UI/source/generated/Layout/MultiColumn/MultiColumn.rst
Normal file
@@ -0,0 +1,72 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
MultiColumn
|
||||
===========
|
||||
|
||||
Class MultiColumn
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/MultiColumn/MultiColumnAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIMultiColumn**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIMultiColumn Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIMultiColumn %}
|
||||
|
||||
:Type:
|
||||
|
||||
+----------+------------+
|
||||
| Standard | No comment |
|
||||
+----------+------------+
|
||||
|
||||
:MultiColumn *Standard* parameters:
|
||||
|
||||
+-----+--------+----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----+--------+----------+------+--+
|
||||
|
||||
:MultiColumn common parameters:
|
||||
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddCSSClass | string | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| AddColumn | Column | |
|
||||
+-------------------+----------+--------------------------------------------------------+
|
||||
| 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/Layout/MultiColumn/MultiColumnFooter.rst
|
||||
83
.doc/UI/source/generated/Layout/UIContentBlock.rst
Normal file
83
.doc/UI/source/generated/Layout/UIContentBlock.rst
Normal file
@@ -0,0 +1,83 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
UIContentBlock
|
||||
==============
|
||||
|
||||
Class UIContentBlock
|
||||
Base block containing sub-blocks
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/UIContentBlockAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIContentBlock**
|
||||
|
||||
:Syntax:
|
||||
|
||||
::
|
||||
|
||||
{% UIContentBlock Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIContentBlock %}
|
||||
|
||||
:Type:
|
||||
|
||||
+----------+-------------------------------------------------------------------+
|
||||
| Standard | No comment |
|
||||
+----------+-------------------------------------------------------------------+
|
||||
| ForCode | Used to display a block of code like <pre> but allows line break. |
|
||||
+----------+-------------------------------------------------------------------+
|
||||
|
||||
:UIContentBlock *Standard* parameters:
|
||||
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| aContainerClasses | array | optional | array () | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
|
||||
:UIContentBlock *ForCode* parameters:
|
||||
|
||||
+-------+--------+-----------+------+--+
|
||||
| sCode | string | mandatory | | |
|
||||
+-------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-------+--------+-----------+------+--+
|
||||
|
||||
:UIContentBlock 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/Layout/UIContentBlockFooter.rst
|
||||
@@ -8,8 +8,8 @@ Welcome to iTop 3.0 UI's documentation!
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
Component/Component
|
||||
Layout/Layout
|
||||
generated/Component/Component
|
||||
generated/Layout/Layout
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
:Success Alert:
|
||||
|
||||
.. image:: /manual/Component/Alert/AlertSuccess.png
|
||||
|
||||
:Failure Alert:
|
||||
|
||||
.. image:: /manual/Component/Alert/AlertFailure.png
|
||||
|
||||
:Information Alert:
|
||||
|
||||
.. image:: /manual/Component/Alert/AlertInformation.png
|
||||
|
||||
:Warning Alert:
|
||||
|
||||
.. image:: /manual/Component/Alert/AlertWarning.png
|
||||
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 4.4 KiB After Width: | Height: | Size: 4.4 KiB |
@@ -1,6 +1,8 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Example to generate an temporary information with a spinner (on the real display the spinner is animated)::
|
||||
|
||||
@@ -14,7 +16,7 @@ Example to generate an temporary information with a spinner (on the real display
|
||||
|
||||
The information displayed:
|
||||
|
||||
.. image:: AlertInformationExample.png
|
||||
.. image:: /manual/Component/Alert/AlertInformationExample.png
|
||||
|
||||
The javascript to set a success or a failure in return of an ajax call::
|
||||
|
||||
@@ -44,4 +46,4 @@ The javascript to show the alert::
|
||||
|
||||
The error displayed:
|
||||
|
||||
.. image:: AlertFailureExample.png
|
||||
.. image:: /manual/Component/Alert/AlertFailureExample.png
|
||||
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 4.5 KiB After Width: | Height: | Size: 4.5 KiB |
|
Before Width: | Height: | Size: 5.9 KiB After Width: | Height: | Size: 5.9 KiB |
|
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
|
Before Width: | Height: | Size: 5.8 KiB After Width: | Height: | Size: 5.8 KiB |
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
@@ -0,0 +1,10 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
:Example Buttons:
|
||||
|
||||
.. image:: /manual/Component/Button/Button-all.png
|
||||
|
||||
11
.doc/UI/source/manual/Component/Button/ButtonFooter.rst
Normal file
11
.doc/UI/source/manual/Component/Button/ButtonFooter.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Button/Button.png
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/ButtonGroup/ButtonGroup.png
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/ButtonGroup/ButtonGroup.png
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/CollapsibleSection/CollapsibleSection.png
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/CollapsibleSection/CollapsibleSection.png
|
||||
@@ -0,0 +1,14 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
Dynamic DataTable
|
||||
|
||||
.. image:: /manual/Component/Datatable/Datatable.png
|
||||
|
||||
Static DataTable
|
||||
|
||||
.. image:: /manual/Component/Datatable/DatatableStatic.png
|
||||
@@ -0,0 +1,27 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
The columns (*aColumns*) have the following format:
|
||||
|
||||
::
|
||||
|
||||
[
|
||||
'nameField1' => ['label' => labelField1, 'description' => descriptionField1],
|
||||
...
|
||||
]
|
||||
|
||||
The data (*aData*) format has to be:
|
||||
|
||||
::
|
||||
|
||||
[
|
||||
['nameField1' => valueField1, 'nameField2' => valueField2, ...],
|
||||
...
|
||||
]
|
||||
|
||||
----
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
|
Before Width: | Height: | Size: 2.2 KiB After Width: | Height: | Size: 2.2 KiB |
@@ -0,0 +1,10 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
:Example Fields:
|
||||
|
||||
.. image:: /manual/Component/Field/Field.png
|
||||
21
.doc/UI/source/manual/Component/Field/FieldFooter.rst
Normal file
21
.doc/UI/source/manual/Component/Field/FieldFooter.rst
Normal file
@@ -0,0 +1,21 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
:Related Tag: :ref:`FieldSet <FieldSet>`
|
||||
|
||||
----
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Example to generate a Field::
|
||||
|
||||
{% UIField Small {sLabel: "Product"} %}
|
||||
iTop
|
||||
{% EndUIField %}
|
||||
|
||||
|
||||
The result:
|
||||
|
||||
.. image:: /manual/Component/Field/Field.png
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/FieldBadge/FieldBadge.png
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/FieldBadge/FieldBadge.png
|
||||
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
@@ -0,0 +1,10 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
:Example FieldSets:
|
||||
|
||||
.. image:: /manual/Component/FieldSet/FieldSet.png
|
||||
22
.doc/UI/source/manual/Component/FieldSet/FieldSetFooter.rst
Normal file
22
.doc/UI/source/manual/Component/FieldSet/FieldSetFooter.rst
Normal file
@@ -0,0 +1,22 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
:Related Tag: :ref:`Field <Field>`
|
||||
|
||||
----
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Example to generate a FieldSet::
|
||||
|
||||
{% UIFieldSet Standard {sLegend: "iTop environment"} %}
|
||||
{% UIField ... %}
|
||||
...
|
||||
{% EndUIFieldSet %}
|
||||
|
||||
The result:
|
||||
|
||||
.. image:: /manual/Component/FieldSet/FieldSet-explained.png
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Form/Form.png
|
||||
|
||||
11
.doc/UI/source/manual/Component/Form/FormFooter.rst
Normal file
11
.doc/UI/source/manual/Component/Form/FormFooter.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Form/Form.png
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Input/FileSelect/FileSelect.png
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Input/FileSelect/FileSelect.png
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Input/Input.png
|
||||
|
||||
11
.doc/UI/source/manual/Component/Input/InputFooter.rst
Normal file
11
.doc/UI/source/manual/Component/Input/InputFooter.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Input/Input.png
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Input/Select/Select.png
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Input/Select/Select.png
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Input/Select/SelectOption.png
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Input/Select/SelectOption.png
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Panel/Panel.png
|
||||
|
||||
11
.doc/UI/source/manual/Component/Panel/PanelFooter.rst
Normal file
11
.doc/UI/source/manual/Component/Panel/PanelFooter.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Panel/Panel.png
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Spinner/Spinner.png
|
||||
|
||||
11
.doc/UI/source/manual/Component/Spinner/SpinnerFooter.rst
Normal file
11
.doc/UI/source/manual/Component/Spinner/SpinnerFooter.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Spinner/Spinner.png
|
||||
|
Before Width: | Height: | Size: 4.3 KiB After Width: | Height: | Size: 4.3 KiB |
@@ -0,0 +1,8 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
.. image:: /manual/Component/Title/Title.png
|
||||
17
.doc/UI/source/manual/Component/Title/TitleFooter.rst
Normal file
17
.doc/UI/source/manual/Component/Title/TitleFooter.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
:The following code:
|
||||
|
||||
::
|
||||
|
||||
{% UITitle ForPage {sTitle: 'UI:FullTextSearchTitle_Text'|dict_format(sFullText)} %}{% EndUITitle %}
|
||||
|
||||
:Will display:
|
||||
|
||||
.. image:: /manual/Component/Title/Title.png
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Toolbar/Toolbar.png
|
||||
|
||||
11
.doc/UI/source/manual/Component/Toolbar/ToolbarFooter.rst
Normal file
11
.doc/UI/source/manual/Component/Toolbar/ToolbarFooter.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Toolbar/Toolbar.png
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.png
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.png
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Layout/MultiColumn/Column/Column.png
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Layout/MultiColumn/Column/Column.png
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Layout/MultiColumn/MultiColumn.png
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Layout/MultiColumn/MultiColumn.png
|
||||
@@ -0,0 +1,12 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Layout/UIContentBlock.png
|
||||
|
||||
11
.doc/UI/source/manual/Layout/UIContentBlockFooter.rst
Normal file
11
.doc/UI/source/manual/Layout/UIContentBlockFooter.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/Layout/UIContentBlock.png
|
||||
Reference in New Issue
Block a user