mirror of
https://github.com/Combodo/iTop.git
synced 2026-04-26 20:18:52 +02:00
798 lines
31 KiB
HTML
798 lines
31 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html4" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Panel — iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="../../../_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="../../../_static/jquery.js"></script>
|
||
<script type="text/javascript" src="../../../_static/underscore.js"></script>
|
||
<script type="text/javascript" src="../../../_static/doctools.js"></script>
|
||
<script type="text/javascript" src="../../../_static/language_data.js"></script>
|
||
<script src="../../../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../../../genindex.html" />
|
||
<link rel="search" title="Search" href="../../../search.html" />
|
||
<link rel="next" title="Spinner" href="../Spinner/Spinner.html" />
|
||
<link rel="prev" title="SelectOption" href="../Input/Select/SelectOption.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
<a href="../../../index.html" class="icon icon-home"> iTop UI<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption"><span class="caption-text">Twig Base:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
|
||
</ul>
|
||
<p class="caption"><span class="caption-text">Tags reference:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="../Component.html">UI Components</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="../Alert/Alert.html">Alert</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../Button/Button.html">Button</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../ButtonGroup/ButtonGroup.html">ButtonGroup</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../CollapsibleSection/CollapsibleSection.html">CollapsibleSection</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../DataTable/DataTable.html">DataTable</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../Field/Field.html">Field</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../FieldBadge/FieldBadge.html">FieldBadge</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../FieldSet/FieldSet.html">FieldSet</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../Form/Form.html">Form</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../Input/FileSelect/FileSelect.html">FileSelect</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../Input/Input.html">Input</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../Input/Select/Select.html">Select</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../Input/Select/SelectOption.html">SelectOption</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Panel</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#output">Output</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#twig-tag">Twig Tag</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#panel-neutral">Panel Neutral</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#panel-forinformation">Panel ForInformation</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#panel-forsuccess">Panel ForSuccess</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#panel-forwarning">Panel ForWarning</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#panel-fordanger">Panel ForDanger</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#panel-forfailure">Panel ForFailure</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#panel-withbrandingprimarycolor">Panel WithBrandingPrimaryColor</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#panel-withbrandingsecondarycolor">Panel WithBrandingSecondaryColor</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#panel-forclass">Panel ForClass</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#panel-common-parameters">Panel common parameters</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../Spinner/Spinner.html">Spinner</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../Title/Title.html">Title</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../Toolbar/Toolbar.html">Toolbar</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../Toolbar/ToolbarSpacer/ToolbarSpacer.html">ToolbarSpacer</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../Layout/Layout.html">UI Layouts</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../../../index.html">iTop UI</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../../../index.html" class="icon icon-home"></a> »</li>
|
||
<li><a href="../Component.html">UI Components</a> »</li>
|
||
<li>Panel</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="../../../_sources/generated/Component/Panel/Panel.rst.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="panel">
|
||
<span id="id1"></span><h1>Panel<a class="headerlink" href="#panel" title="Permalink to this headline">¶</a></h1>
|
||
<p>Class Panel</p>
|
||
<hr class="docutils" />
|
||
<div class="section" id="output">
|
||
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline">¶</a></h2>
|
||
<p>No output provided yet</p>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="twig-tag">
|
||
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline">¶</a></h2>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UIPanel</strong></td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIPanel</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||
<span class="x"> Content Goes Here</span>
|
||
<span class="cp">{%</span> <span class="k">EndUIPanel</span> <span class="cp">%}</span><span class="x"></span>
|
||
</pre></div>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="52%" />
|
||
<col width="48%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td><a class="reference internal" href="#panelneutral"><span class="std std-ref">Neutral</span></a></td>
|
||
<td>Make a basis Panel component</td>
|
||
</tr>
|
||
<tr class="row-even"><td><a class="reference internal" href="#panelforinformation"><span class="std std-ref">ForInformation</span></a></td>
|
||
<td>Make a Panel component for informational messages</td>
|
||
</tr>
|
||
<tr class="row-odd"><td><a class="reference internal" href="#panelforsuccess"><span class="std std-ref">ForSuccess</span></a></td>
|
||
<td>Make a Panel component for successful messages</td>
|
||
</tr>
|
||
<tr class="row-even"><td><a class="reference internal" href="#panelforwarning"><span class="std std-ref">ForWarning</span></a></td>
|
||
<td>Make a Panel component for warning messages</td>
|
||
</tr>
|
||
<tr class="row-odd"><td><a class="reference internal" href="#panelfordanger"><span class="std std-ref">ForDanger</span></a></td>
|
||
<td>Make a Panel component for danger messages</td>
|
||
</tr>
|
||
<tr class="row-even"><td><a class="reference internal" href="#panelforfailure"><span class="std std-ref">ForFailure</span></a></td>
|
||
<td>Make a Panel component for failure messages</td>
|
||
</tr>
|
||
<tr class="row-odd"><td><a class="reference internal" href="#panelwithbrandingprimarycolor"><span class="std std-ref">WithBrandingPrimaryColor</span></a></td>
|
||
<td>Make a Panel component with primary color scheme</td>
|
||
</tr>
|
||
<tr class="row-even"><td><a class="reference internal" href="#panelwithbrandingsecondarycolor"><span class="std std-ref">WithBrandingSecondaryColor</span></a></td>
|
||
<td>Make a Panel component with secondary color scheme</td>
|
||
</tr>
|
||
<tr class="row-odd"><td><a class="reference internal" href="#panelforclass"><span class="std std-ref">ForClass</span></a></td>
|
||
<td>Make a Panel component with the specific $sClass color scheme</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="section" id="panel-neutral">
|
||
<span id="panelneutral"></span><h3>Panel Neutral<a class="headerlink" href="#panel-neutral" title="Permalink to this headline">¶</a></h3>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIPanel</span> <span class="p">N</span><span class="nv">eutral</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sSubTitle</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||
<span class="x"> Content Goes Here</span>
|
||
<span class="cp">{%</span> <span class="k">EndUIPanel</span> <span class="cp">%}</span><span class="x"></span>
|
||
</pre></div>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="29%" />
|
||
<col width="21%" />
|
||
<col width="29%" />
|
||
<col width="16%" />
|
||
<col width="5%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td>sTitle</td>
|
||
<td>string</td>
|
||
<td>mandatory</td>
|
||
<td> </td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>sSubTitle</td>
|
||
<td>string</td>
|
||
<td>optional</td>
|
||
<td>NULL</td>
|
||
<td> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="section" id="panel-forinformation">
|
||
<span id="panelforinformation"></span><h3>Panel ForInformation<a class="headerlink" href="#panel-forinformation" title="Permalink to this headline">¶</a></h3>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIPanel</span> <span class="p">F</span><span class="nv">orInformation</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sSubTitle</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||
<span class="x"> Content Goes Here</span>
|
||
<span class="cp">{%</span> <span class="k">EndUIPanel</span> <span class="cp">%}</span><span class="x"></span>
|
||
</pre></div>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="29%" />
|
||
<col width="21%" />
|
||
<col width="29%" />
|
||
<col width="16%" />
|
||
<col width="5%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td>sTitle</td>
|
||
<td>string</td>
|
||
<td>mandatory</td>
|
||
<td> </td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>sSubTitle</td>
|
||
<td>string</td>
|
||
<td>optional</td>
|
||
<td>NULL</td>
|
||
<td> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="section" id="panel-forsuccess">
|
||
<span id="panelforsuccess"></span><h3>Panel ForSuccess<a class="headerlink" href="#panel-forsuccess" title="Permalink to this headline">¶</a></h3>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIPanel</span> <span class="p">F</span><span class="nv">orSuccess</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sSubTitle</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||
<span class="x"> Content Goes Here</span>
|
||
<span class="cp">{%</span> <span class="k">EndUIPanel</span> <span class="cp">%}</span><span class="x"></span>
|
||
</pre></div>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="29%" />
|
||
<col width="21%" />
|
||
<col width="29%" />
|
||
<col width="16%" />
|
||
<col width="5%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td>sTitle</td>
|
||
<td>string</td>
|
||
<td>mandatory</td>
|
||
<td> </td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>sSubTitle</td>
|
||
<td>string</td>
|
||
<td>optional</td>
|
||
<td>NULL</td>
|
||
<td> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="section" id="panel-forwarning">
|
||
<span id="panelforwarning"></span><h3>Panel ForWarning<a class="headerlink" href="#panel-forwarning" title="Permalink to this headline">¶</a></h3>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIPanel</span> <span class="p">F</span><span class="nv">orWarning</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sSubTitle</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||
<span class="x"> Content Goes Here</span>
|
||
<span class="cp">{%</span> <span class="k">EndUIPanel</span> <span class="cp">%}</span><span class="x"></span>
|
||
</pre></div>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="29%" />
|
||
<col width="21%" />
|
||
<col width="29%" />
|
||
<col width="16%" />
|
||
<col width="5%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td>sTitle</td>
|
||
<td>string</td>
|
||
<td>mandatory</td>
|
||
<td> </td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>sSubTitle</td>
|
||
<td>string</td>
|
||
<td>optional</td>
|
||
<td>NULL</td>
|
||
<td> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="section" id="panel-fordanger">
|
||
<span id="panelfordanger"></span><h3>Panel ForDanger<a class="headerlink" href="#panel-fordanger" title="Permalink to this headline">¶</a></h3>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIPanel</span> <span class="p">F</span><span class="nv">orDanger</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sSubTitle</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||
<span class="x"> Content Goes Here</span>
|
||
<span class="cp">{%</span> <span class="k">EndUIPanel</span> <span class="cp">%}</span><span class="x"></span>
|
||
</pre></div>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="29%" />
|
||
<col width="21%" />
|
||
<col width="29%" />
|
||
<col width="16%" />
|
||
<col width="5%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td>sTitle</td>
|
||
<td>string</td>
|
||
<td>mandatory</td>
|
||
<td> </td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>sSubTitle</td>
|
||
<td>string</td>
|
||
<td>optional</td>
|
||
<td>NULL</td>
|
||
<td> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="section" id="panel-forfailure">
|
||
<span id="panelforfailure"></span><h3>Panel ForFailure<a class="headerlink" href="#panel-forfailure" title="Permalink to this headline">¶</a></h3>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIPanel</span> <span class="p">F</span><span class="nv">orFailure</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sSubTitle</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||
<span class="x"> Content Goes Here</span>
|
||
<span class="cp">{%</span> <span class="k">EndUIPanel</span> <span class="cp">%}</span><span class="x"></span>
|
||
</pre></div>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="29%" />
|
||
<col width="21%" />
|
||
<col width="29%" />
|
||
<col width="16%" />
|
||
<col width="5%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td>sTitle</td>
|
||
<td>string</td>
|
||
<td>mandatory</td>
|
||
<td> </td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>sSubTitle</td>
|
||
<td>string</td>
|
||
<td>optional</td>
|
||
<td>NULL</td>
|
||
<td> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="section" id="panel-withbrandingprimarycolor">
|
||
<span id="panelwithbrandingprimarycolor"></span><h3>Panel WithBrandingPrimaryColor<a class="headerlink" href="#panel-withbrandingprimarycolor" title="Permalink to this headline">¶</a></h3>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIPanel</span> <span class="p">W</span><span class="nv">ithBrandingPrimaryColor</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sSubTitle</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||
<span class="x"> Content Goes Here</span>
|
||
<span class="cp">{%</span> <span class="k">EndUIPanel</span> <span class="cp">%}</span><span class="x"></span>
|
||
</pre></div>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="29%" />
|
||
<col width="21%" />
|
||
<col width="29%" />
|
||
<col width="16%" />
|
||
<col width="5%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td>sTitle</td>
|
||
<td>string</td>
|
||
<td>mandatory</td>
|
||
<td> </td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>sSubTitle</td>
|
||
<td>string</td>
|
||
<td>optional</td>
|
||
<td>NULL</td>
|
||
<td> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="section" id="panel-withbrandingsecondarycolor">
|
||
<span id="panelwithbrandingsecondarycolor"></span><h3>Panel WithBrandingSecondaryColor<a class="headerlink" href="#panel-withbrandingsecondarycolor" title="Permalink to this headline">¶</a></h3>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIPanel</span> <span class="p">W</span><span class="nv">ithBrandingSecondaryColor</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sSubTitle</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||
<span class="x"> Content Goes Here</span>
|
||
<span class="cp">{%</span> <span class="k">EndUIPanel</span> <span class="cp">%}</span><span class="x"></span>
|
||
</pre></div>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="29%" />
|
||
<col width="21%" />
|
||
<col width="29%" />
|
||
<col width="16%" />
|
||
<col width="5%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td>sTitle</td>
|
||
<td>string</td>
|
||
<td>mandatory</td>
|
||
<td> </td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>sSubTitle</td>
|
||
<td>string</td>
|
||
<td>optional</td>
|
||
<td>NULL</td>
|
||
<td> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="section" id="panel-forclass">
|
||
<span id="panelforclass"></span><h3>Panel ForClass<a class="headerlink" href="#panel-forclass" title="Permalink to this headline">¶</a></h3>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIPanel</span> <span class="p">F</span><span class="nv">orClass</span> <span class="o">{</span><span class="nv">sClass</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sTitle</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sSubTitle</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||
<span class="x"> Content Goes Here</span>
|
||
<span class="cp">{%</span> <span class="k">EndUIPanel</span> <span class="cp">%}</span><span class="x"></span>
|
||
</pre></div>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="15%" />
|
||
<col width="11%" />
|
||
<col width="15%" />
|
||
<col width="8%" />
|
||
<col width="51%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td>sClass</td>
|
||
<td>string</td>
|
||
<td>mandatory</td>
|
||
<td> </td>
|
||
<td>Class of the object the panel is for</td>
|
||
</tr>
|
||
<tr class="row-even"><td>sTitle</td>
|
||
<td>string</td>
|
||
<td>mandatory</td>
|
||
<td> </td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>sSubTitle</td>
|
||
<td>string</td>
|
||
<td>optional</td>
|
||
<td>NULL</td>
|
||
<td> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="section" id="panel-common-parameters">
|
||
<h3>Panel common parameters<a class="headerlink" href="#panel-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="27%" />
|
||
<col width="16%" />
|
||
<col width="57%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td>AddCSSClass</td>
|
||
<td>string</td>
|
||
<td>CSS class to add to the generated html block</td>
|
||
</tr>
|
||
<tr class="row-even"><td>AddCSSClasses</td>
|
||
<td>array</td>
|
||
<td>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></td>
|
||
</tr>
|
||
<tr class="row-odd"><td>AddCssFileRelPath</td>
|
||
<td>string</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>AddDeferredBlock</td>
|
||
<td>iUIBlock</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>AddHtml</td>
|
||
<td>string</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>AddJsFileRelPath</td>
|
||
<td>string</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>AddMainBlock</td>
|
||
<td>iUIBlock</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>AddMainBlocks</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>AddSubBlock</td>
|
||
<td>iUIBlock</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>AddSubTitleBlock</td>
|
||
<td>iUIBlock</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>AddSubTitleBlocks</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>AddTitleBlock</td>
|
||
<td>iUIBlock</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>AddTitleBlocks</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>AddToolbarBlock</td>
|
||
<td>iUIBlock</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>AddToolbarBlocks</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>CSSClasses</td>
|
||
<td>array</td>
|
||
<td>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></td>
|
||
</tr>
|
||
<tr class="row-odd"><td>CSSColorClass</td>
|
||
<td>string</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>ColorFromClass</td>
|
||
<td>string</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>ColorFromColorSemantic</td>
|
||
<td>string</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>ColorFromOrmStyle</td>
|
||
<td>ormStyle</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>DataAttributes</td>
|
||
<td>array</td>
|
||
<td>Array of data attributes in the format [‘name’ => ‘value’]</td>
|
||
</tr>
|
||
<tr class="row-even"><td>DeferredBlocks</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>IsCollapsible</td>
|
||
<td>bool</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>IsHeaderVisibleOnScroll</td>
|
||
<td>bool</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>IsHidden</td>
|
||
<td>bool</td>
|
||
<td>Indicates if the block is hidden by default</td>
|
||
</tr>
|
||
<tr class="row-even"><td>MainBlocks</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>SubBlocks</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>SubTitle</td>
|
||
<td>string</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>SubTitleBlock</td>
|
||
<td>iUIContentBlock</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>Title</td>
|
||
<td>string</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>TitleBlock</td>
|
||
<td>iUIContentBlock</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>ToolBlocks</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="examples">
|
||
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
|
||
<p>No examples provided yet</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="../Input/Select/SelectOption.html" class="btn btn-neutral float-left" title="SelectOption" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="../Spinner/Spinner.html" class="btn btn-neutral float-right" title="Spinner" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2021, Combodo.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |