FAF: Documentation UI Twig Blocks (get @see comments)

This commit is contained in:
Eric
2021-05-31 13:42:30 +02:00
parent 9a9856fb0d
commit 94fbb91ad2
22 changed files with 84 additions and 62 deletions

View File

@@ -239,13 +239,13 @@ Alert common parameters
+-------------------+----------+------------------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+------------------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------------------+
| AddDeferredBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------------------+
| AddHtml | string | |
+-------------------+----------+------------------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------------------+
| AddSubBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------------------+

View File

@@ -72,13 +72,13 @@ Button Neutral
:parameters:
+--------+--------+-----------+------+----------------------------+
| sLabel | string | mandatory | | |
+--------+--------+-----------+------+----------------------------+
| sName | string | optional | NULL | See {@link Button::$sName} |
+--------+--------+-----------+------+----------------------------+
| sId | string | optional | NULL | |
+--------+--------+-----------+------+----------------------------+
+--------+--------+-----------+------+--------------------------------------------+
| sLabel | string | mandatory | | |
+--------+--------+-----------+------+--------------------------------------------+
| sName | string | optional | NULL | The HTML name of the button, used by forms |
+--------+--------+-----------+------+--------------------------------------------+
| sId | string | optional | NULL | UIBBlock main HTML tag id |
+--------+--------+-----------+------+--------------------------------------------+
.. _ButtonForPrimaryAction:
@@ -443,11 +443,11 @@ Button common parameters
+-------------------+--------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+--------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+--------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+--------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+--------+------------------------------------------------------------+
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+--------+------------------------------------------------------------+

View File

@@ -61,13 +61,13 @@ ButtonGroup common parameters
+-------------------+----------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddExtraBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+----------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| Buttons | array | |
+-------------------+----------+------------------------------------------------------------+

View File

@@ -61,13 +61,13 @@ CollapsibleSection common parameters
+-------------------+----------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddDeferredBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+----------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddSubBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+

View File

@@ -202,13 +202,13 @@ DataTable common parameters
+-------------------+----------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddDeferredBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+----------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddSubBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+

View File

@@ -155,13 +155,13 @@ Field common parameters
+-------------------+----------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddDeferredBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+----------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddSubBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+

View File

@@ -61,13 +61,13 @@ FieldBadge common parameters
+-------------------+----------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddDeferredBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+----------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddSubBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+

View File

@@ -61,13 +61,13 @@ FieldSet common parameters
+-------------------+----------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddDeferredBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+----------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddSubBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+

View File

@@ -61,13 +61,13 @@ Form common parameters
+-------------------+----------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddDeferredBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+----------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddSubBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+

View File

@@ -57,11 +57,11 @@ FileSelect common parameters
+-------------------+--------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+--------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+--------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+--------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+--------+------------------------------------------------------------+
| ButtonText | string | |
+-------------------+--------+------------------------------------------------------------+

View File

@@ -111,11 +111,11 @@ Input common parameters
+-------------------+--------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+--------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+--------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+--------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+--------+------------------------------------------------------------+
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+--------+------------------------------------------------------------+

View File

@@ -86,13 +86,13 @@ Select common parameters
+-------------------+--------------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+--------------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+--------------+------------------------------------------------------------+
| AddDeferredBlock | iUIBlock | |
+-------------------+--------------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+--------------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+--------------+------------------------------------------------------------+
| AddOption | SelectOption | |
+-------------------+--------------+------------------------------------------------------------+

View File

@@ -61,11 +61,11 @@ SelectOption common parameters
+-------------------+--------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+--------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+--------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+--------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+--------+------------------------------------------------------------+
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+--------+------------------------------------------------------------+

View File

@@ -247,19 +247,19 @@ Panel common parameters
+-------------------------+-----------------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------------+-----------------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------------+-----------------+------------------------------------------------------------+
| AddDeferredBlock | iUIBlock | |
+-------------------------+-----------------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------------+-----------------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------------+-----------------+------------------------------------------------------------+
| AddMainBlock | iUIBlock | |
+-------------------------+-----------------+------------------------------------------------------------+
| AddMainBlocks | array | |
+-------------------------+-----------------+------------------------------------------------------------+
| AddSubBlock | iUIBlock | directly in the main area |
| AddSubBlock | iUIBlock | |
+-------------------------+-----------------+------------------------------------------------------------+
| AddSubTitleBlock | iUIBlock | |
+-------------------------+-----------------+------------------------------------------------------------+

View File

@@ -55,11 +55,11 @@ Spinner common parameters
+-------------------+--------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+--------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+--------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+--------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+--------+------------------------------------------------------------+
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+--------+------------------------------------------------------------+

View File

@@ -140,13 +140,13 @@ Title common parameters
+-------------------+----------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddDeferredBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+----------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddSubBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+

View File

@@ -105,13 +105,13 @@ Toolbar common parameters
+-------------------+----------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddDeferredBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+----------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+----------+------------------------------------------------------------+
| AddSubBlock | iUIBlock | |
+-------------------+----------+------------------------------------------------------------+

View File

@@ -55,11 +55,11 @@ ToolbarSpacer common parameters
+-------------------+--------+------------------------------------------------------------+
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+--------+------------------------------------------------------------+
| AddCssFileRelPath | string | relative path of a CSS file to add |
| AddCssFileRelPath | string | |
+-------------------+--------+------------------------------------------------------------+
| AddHtml | string | |
+-------------------+--------+------------------------------------------------------------+
| AddJsFileRelPath | string | relative path of a JS file to add |
| AddJsFileRelPath | string | |
+-------------------+--------+------------------------------------------------------------+
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+--------+------------------------------------------------------------+