mirror of
https://github.com/Combodo/iTop.git
synced 2026-04-27 12:38:44 +02:00
FAF: Documentation UI Twig Blocks - HTML result
This commit is contained in:
Eric
835
.doc/UI/build/html/generated/Component/Alert/Alert.html
Normal file
835
.doc/UI/build/html/generated/Component/Alert/Alert.html
Normal file
@@ -0,0 +1,835 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Alert — 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 type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="Button" href="../Button/Button.html" />
|
||||
<link rel="prev" title="UI Components" href="../Component.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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 current"><a class="current reference internal" href="#">Alert</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="#alert-neutral">Alert Neutral</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#alert-forinformation">Alert ForInformation</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#alert-forsuccess">Alert ForSuccess</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#alert-forwarning">Alert ForWarning</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#alert-fordanger">Alert ForDanger</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#alert-forfailure">Alert ForFailure</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#alert-withbrandingprimarycolor">Alert WithBrandingPrimaryColor</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#alert-withbrandingsecondarycolor">Alert WithBrandingSecondaryColor</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#alert-common-parameters">Alert 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="../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"><a class="reference internal" href="../Panel/Panel.html">Panel</a></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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>Alert</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../_sources/generated/Component/Alert/Alert.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="alert">
|
||||
<span id="id1"></span><h1>Alert<a class="headerlink" href="#alert" title="Permalink to this headline">¶</a></h1>
|
||||
<p>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.</p>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="output">
|
||||
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Success Alert</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<img alt="../../../_images/AlertSuccess.png" src="../../../_images/AlertSuccess.png" />
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Failure Alert</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<img alt="../../../_images/AlertFailure.png" src="../../../_images/AlertFailure.png" />
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Information Alert</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<img alt="../../../_images/AlertInformation.png" src="../../../_images/AlertInformation.png" />
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Warning Alert</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<img alt="../../../_images/AlertWarning.png" src="../../../_images/AlertWarning.png" />
|
||||
</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UIAlert</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIAlert</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">EndUIAlert</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 57%" />
|
||||
<col style="width: 43%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#alertneutral"><span class="std std-ref">Neutral</span></a></p></td>
|
||||
<td><p>Make a basis Alert component</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#alertforinformation"><span class="std std-ref">ForInformation</span></a></p></td>
|
||||
<td><p>Make an Alert component for informational messages</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#alertforsuccess"><span class="std std-ref">ForSuccess</span></a></p></td>
|
||||
<td><p>Make an Alert component for successful messages</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#alertforwarning"><span class="std std-ref">ForWarning</span></a></p></td>
|
||||
<td><p>Make an Alert component for warning messages</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#alertfordanger"><span class="std std-ref">ForDanger</span></a></p></td>
|
||||
<td><p>Make an Alert component for danger messages</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#alertforfailure"><span class="std std-ref">ForFailure</span></a></p></td>
|
||||
<td><p>Make an Alert component for failure messages</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#alertwithbrandingprimarycolor"><span class="std std-ref">WithBrandingPrimaryColor</span></a></p></td>
|
||||
<td><p>Make an Alert component with primary color scheme</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#alertwithbrandingsecondarycolor"><span class="std std-ref">WithBrandingSecondaryColor</span></a></p></td>
|
||||
<td><p>Make an Alert component with secondary color scheme</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="alert-neutral">
|
||||
<span id="alertneutral"></span><h3>Alert Neutral<a class="headerlink" href="#alert-neutral" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIAlert</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">sContent</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUIAlert</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 7%" />
|
||||
<col style="width: 59%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>Title of the alert</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sContent</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>The raw HTML content, must be already sanitized</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td><p>id of the html block</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="alert-forinformation">
|
||||
<span id="alertforinformation"></span><h3>Alert ForInformation<a class="headerlink" href="#alert-forinformation" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIAlert</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">sContent</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUIAlert</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 7%" />
|
||||
<col style="width: 59%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>Title of the alert</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sContent</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>The raw HTML content, must be already sanitized</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td><p>id of the html block</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="alert-forsuccess">
|
||||
<span id="alertforsuccess"></span><h3>Alert ForSuccess<a class="headerlink" href="#alert-forsuccess" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIAlert</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">sContent</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUIAlert</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 7%" />
|
||||
<col style="width: 59%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>Title of the alert</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sContent</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>The raw HTML content, must be already sanitized</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="alert-forwarning">
|
||||
<span id="alertforwarning"></span><h3>Alert ForWarning<a class="headerlink" href="#alert-forwarning" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIAlert</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">sContent</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUIAlert</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 7%" />
|
||||
<col style="width: 59%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>Title of the alert</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sContent</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>The raw HTML content, must be already sanitized</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td><p>id of the html block</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="alert-fordanger">
|
||||
<span id="alertfordanger"></span><h3>Alert ForDanger<a class="headerlink" href="#alert-fordanger" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIAlert</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">sContent</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUIAlert</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 7%" />
|
||||
<col style="width: 59%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>Title of the alert</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sContent</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>The raw HTML content, must be already sanitized</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td><p>id of the html block</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="alert-forfailure">
|
||||
<span id="alertforfailure"></span><h3>Alert ForFailure<a class="headerlink" href="#alert-forfailure" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIAlert</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">sContent</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUIAlert</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 7%" />
|
||||
<col style="width: 59%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>Title of the alert</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sContent</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>The raw HTML content, must be already sanitized</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td><p>id of the html block</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="alert-withbrandingprimarycolor">
|
||||
<span id="alertwithbrandingprimarycolor"></span><h3>Alert WithBrandingPrimaryColor<a class="headerlink" href="#alert-withbrandingprimarycolor" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIAlert</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">sContent</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUIAlert</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 7%" />
|
||||
<col style="width: 59%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>Title of the alert</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sContent</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>The raw HTML content, must be already sanitized</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td><p>id of the html block</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="alert-withbrandingsecondarycolor">
|
||||
<span id="alertwithbrandingsecondarycolor"></span><h3>Alert WithBrandingSecondaryColor<a class="headerlink" href="#alert-withbrandingsecondarycolor" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIAlert</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">sContent</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUIAlert</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 7%" />
|
||||
<col style="width: 59%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>Title of the alert</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sContent</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td><p>The raw HTML content, must be already sanitized</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td><p>id of the html block</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="alert-common-parameters">
|
||||
<h3>Alert common parameters<a class="headerlink" href="#alert-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 26%" />
|
||||
<col style="width: 9%" />
|
||||
<col style="width: 65%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddSubBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>Color</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>Color of the alert (check CSS classes ibo-is-<color> for colors)</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Content</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>The raw HTML content, must be already sanitized</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>DeferredBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsClosable</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the user can remove the alert from the screen</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsCollapsible</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the user can collapse the alert to display only the title</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>OpenedByDefault</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the alert is collapsed or not by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>SubBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Title</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>Title of the alert</p></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>Example to generate an temporary information with a spinner (on the real display the spinner is animated)</p>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIAlert</span> <span class="p">F</span><span class="nv">orInformation</span> <span class="o">{</span><span class="s1">'sId':'header-requirements'</span><span class="o">,</span> <span class="s1">'IsCollapsible'</span><span class="o">:</span><span class="kp">false</span><span class="o">,</span> <span class="s1">'IsClosable'</span><span class="o">:</span><span class="kp">false</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||||
<span class="x"> </span><span class="cp">{%</span> <span class="k">UIContentBlock</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="s1">'aContainerClasses'</span><span class="o">:[</span><span class="s1">'ibo-update-core-header-requirements'</span><span class="o">],</span>
|
||||
<span class="s1">'sId':'can-core-update'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||||
<span class="x"> </span><span class="cp">{{</span> <span class="s1">'iTopUpdate:UI:CanCoreUpdate:Loading'</span><span class="o">|</span><span class="nf">dict_s</span> <span class="cp">}}</span><span class="x"></span>
|
||||
<span class="x"> </span><span class="cp">{%</span> <span class="k">UISpinner</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{}</span> <span class="cp">%}</span><span class="x"></span>
|
||||
<span class="x"> </span><span class="cp">{%</span> <span class="k">EndUIContentBlock</span> <span class="cp">%}</span><span class="x"></span>
|
||||
<span class="cp">{%</span> <span class="k">EndUIAlert</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The information displayed:</p>
|
||||
<img alt="../../../_images/AlertInformationExample.png" src="../../../_images/AlertInformationExample.png" />
|
||||
<p>The javascript to set a success or a failure in return of an ajax call</p>
|
||||
<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="kd">function</span> <span class="p">(</span><span class="nx">data</span><span class="p">)</span> <span class="p">{</span>
|
||||
<span class="kd">var</span> <span class="nx">oRequirements</span> <span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="s2">"#header-requirements"</span><span class="p">);</span>
|
||||
<span class="kd">var</span> <span class="nx">oCanCoreUpdate</span> <span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="s2">"#can-core-update"</span><span class="p">);</span>
|
||||
<span class="nx">oCanCoreUpdate</span><span class="p">.</span><span class="nx">html</span><span class="p">(</span><span class="nx">data</span><span class="p">.</span><span class="nx">sMessage</span><span class="p">);</span>
|
||||
<span class="nx">oRequirements</span><span class="p">.</span><span class="nx">removeClass</span><span class="p">(</span><span class="s2">"ibo-is-information"</span><span class="p">);</span>
|
||||
<span class="k">if</span> <span class="p">(</span><span class="nx">data</span><span class="p">.</span><span class="nx">bStatus</span><span class="p">)</span> <span class="p">{</span>
|
||||
<span class="nx">oRequirements</span><span class="p">.</span><span class="nx">addClass</span><span class="p">(</span><span class="s2">"ibo-is-success"</span><span class="p">);</span>
|
||||
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
|
||||
<span class="nx">oRequirements</span><span class="p">.</span><span class="nx">addClass</span><span class="p">(</span><span class="s2">"ibo-is-failure"</span><span class="p">);</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<p>Example to generate a hidden alert to display using javascript in case of error</p>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIAlert</span> <span class="p">F</span><span class="nv">orFailure</span> <span class="o">{</span><span class="nv">sId</span><span class="s2">:"dir_error_outer"</span><span class="o">,</span> <span class="p">I</span><span class="nv">sCollapsible</span><span class="o">:</span><span class="kp">false</span><span class="o">,</span> <span class="p">I</span><span class="nv">sClosable</span><span class="o">:</span><span class="kp">false</span><span class="o">,</span> <span class="p">I</span><span class="nv">sHidden</span><span class="o">:</span><span class="kp">true</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||||
<span class="x"> *The content goes here*</span>
|
||||
<span class="cp">{%</span> <span class="k">EndUIAlert</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The javascript to show the alert</p>
|
||||
<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="nx">$</span><span class="p">(</span><span class="s2">"#dir_error_outer"</span><span class="p">).</span><span class="nx">removeClass</span><span class="p">(</span><span class="s2">"ibo-is-hidden"</span><span class="p">);</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The error displayed:</p>
|
||||
<img alt="../../../_images/AlertFailureExample.png" src="../../../_images/AlertFailureExample.png" />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="../Button/Button.html" class="btn btn-neutral float-right" title="Button" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../Component.html" class="btn btn-neutral float-left" title="UI Components" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
1260
.doc/UI/build/html/generated/Component/Button/Button.html
Normal file
1260
.doc/UI/build/html/generated/Component/Button/Button.html
Normal file
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,400 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>ButtonGroup — 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 type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="CollapsibleSection" href="../CollapsibleSection/CollapsibleSection.html" />
|
||||
<link rel="prev" title="Button" href="../Button/Button.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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 current"><a class="current reference internal" href="#">ButtonGroup</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="#buttongroup-buttonwithoptionsmenu">ButtonGroup ButtonWithOptionsMenu</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#buttongroup-common-parameters">ButtonGroup 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="../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"><a class="reference internal" href="../Panel/Panel.html">Panel</a></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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>ButtonGroup</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../_sources/generated/Component/ButtonGroup/ButtonGroup.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="buttongroup">
|
||||
<span id="id1"></span><h1>ButtonGroup<a class="headerlink" href="#buttongroup" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class ButtonGroup</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UIButtonGroup</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIButtonGroup</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>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 40%" />
|
||||
<col style="width: 60%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#buttongroupbuttonwithoptionsmenu"><span class="std std-ref">ButtonWithOptionsMenu</span></a></p></td>
|
||||
<td><p>Make a button that has a primary action ($oButton) but also an options menu ($oMenu) on the side</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="buttongroup-buttonwithoptionsmenu">
|
||||
<span id="buttongroupbuttonwithoptionsmenu"></span><h3>ButtonGroup ButtonWithOptionsMenu<a class="headerlink" href="#buttongroup-buttonwithoptionsmenu" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIButtonGroup</span> <span class="p">B</span><span class="nv">uttonWithOptionsMenu</span> <span class="o">{</span><span class="nv">oButton</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">oMenu</span><span class="o">:</span><span class="nv">value</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 24%" />
|
||||
<col style="width: 35%" />
|
||||
<col style="width: 30%" />
|
||||
<col style="width: 5%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>oButton</p></td>
|
||||
<td><p>Button</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>oMenu</p></td>
|
||||
<td><p>PopoverMenu</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="buttongroup-common-parameters">
|
||||
<h3>ButtonGroup common parameters<a class="headerlink" href="#buttongroup-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 61%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddButton</p></td>
|
||||
<td><p>Button</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddButtons</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddExtraBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>Buttons</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></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 navigation">
|
||||
|
||||
<a href="../CollapsibleSection/CollapsibleSection.html" class="btn btn-neutral float-right" title="CollapsibleSection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../Button/Button.html" class="btn btn-neutral float-left" title="Button" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,408 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>CollapsibleSection — 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 type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="DataTable" href="../DataTable/DataTable.html" />
|
||||
<link rel="prev" title="ButtonGroup" href="../ButtonGroup/ButtonGroup.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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 current"><a class="current reference internal" href="#">CollapsibleSection</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="#collapsiblesection-standard">CollapsibleSection Standard</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#collapsiblesection-common-parameters">CollapsibleSection 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="../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"><a class="reference internal" href="../Panel/Panel.html">Panel</a></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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>CollapsibleSection</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../_sources/generated/Component/CollapsibleSection/CollapsibleSection.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="collapsiblesection">
|
||||
<span id="id1"></span><h1>CollapsibleSection<a class="headerlink" href="#collapsiblesection" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class CollapsibleSection</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UICollapsibleSection</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UICollapsibleSection</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">EndUICollapsibleSection</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 79%" />
|
||||
<col style="width: 21%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#collapsiblesectionstandard"><span class="std std-ref">Standard</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="collapsiblesection-standard">
|
||||
<span id="collapsiblesectionstandard"></span><h3>CollapsibleSection Standard<a class="headerlink" href="#collapsiblesection-standard" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UICollapsibleSection</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUICollapsibleSection</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 23%" />
|
||||
<col style="width: 23%" />
|
||||
<col style="width: 31%" />
|
||||
<col style="width: 17%" />
|
||||
<col style="width: 6%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="collapsiblesection-common-parameters">
|
||||
<h3>CollapsibleSection common parameters<a class="headerlink" href="#collapsiblesection-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 61%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddSubBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>DeferredBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>OpenedByDefault</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>SubBlocks</p></td>
|
||||
<td><p>array</p></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 navigation">
|
||||
|
||||
<a href="../DataTable/DataTable.html" class="btn btn-neutral float-right" title="DataTable" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../ButtonGroup/ButtonGroup.html" class="btn btn-neutral float-left" title="ButtonGroup" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
268
.doc/UI/build/html/generated/Component/Component.html
Normal file
268
.doc/UI/build/html/generated/Component/Component.html
Normal file
@@ -0,0 +1,268 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>UI Components — 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 type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||
<script src="../../_static/jquery.js"></script>
|
||||
<script src="../../_static/underscore.js"></script>
|
||||
<script src="../../_static/doctools.js"></script>
|
||||
<script src="../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="Alert" href="Alert/Alert.html" />
|
||||
<link rel="prev" title="Twig Base Reference" href="../../TwigBaseReference/TwigBaseReference.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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="current reference internal" href="#">UI Components</a><ul>
|
||||
<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"><a class="reference internal" href="Panel/Panel.html">Panel</a></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="top navigation">
|
||||
|
||||
<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="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="../../index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>UI Components</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../_sources/generated/Component/Component.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="ui-components">
|
||||
<span id="components"></span><h1>UI Components<a class="headerlink" href="#ui-components" title="Permalink to this headline">¶</a></h1>
|
||||
<p>A UI component is a unitary block used to display information in iTop console.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption"><span class="caption-text">Components:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Alert/Alert.html">Alert</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Button/Button.html">Button</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ButtonGroup/ButtonGroup.html">ButtonGroup</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="CollapsibleSection/CollapsibleSection.html">CollapsibleSection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="DataTable/DataTable.html">DataTable</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Field/Field.html">Field</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="FieldBadge/FieldBadge.html">FieldBadge</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="FieldSet/FieldSet.html">FieldSet</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Form/Form.html">Form</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Input/FileSelect/FileSelect.html">FileSelect</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Input/Input.html">Input</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Input/Select/Select.html">Select</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Input/Select/SelectOption.html">SelectOption</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Panel/Panel.html">Panel</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Spinner/Spinner.html">Spinner</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Title/Title.html">Title</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Toolbar/Toolbar.html">Toolbar</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Toolbar/ToolbarSpacer/ToolbarSpacer.html">ToolbarSpacer</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="Alert/Alert.html" class="btn btn-neutral float-right" title="Alert" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../../TwigBaseReference/TwigBaseReference.html" class="btn btn-neutral float-left" title="Twig Base Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
739
.doc/UI/build/html/generated/Component/DataTable/DataTable.html
Normal file
739
.doc/UI/build/html/generated/Component/DataTable/DataTable.html
Normal file
@@ -0,0 +1,739 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>DataTable — 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 type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="Field" href="../Field/Field.html" />
|
||||
<link rel="prev" title="CollapsibleSection" href="../CollapsibleSection/CollapsibleSection.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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 current"><a class="current reference internal" href="#">DataTable</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="#datatable-forresult">DataTable ForResult</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#datatable-forobject">DataTable ForObject</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#datatable-forrendering">DataTable ForRendering</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#datatable-forrenderingobject">DataTable ForRenderingObject</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#datatable-forstaticdata">DataTable ForStaticData</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#datatable-forform">DataTable ForForm</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#datatable-common-parameters">DataTable 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="../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"><a class="reference internal" href="../Panel/Panel.html">Panel</a></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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>DataTable</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../_sources/generated/Component/DataTable/DataTable.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="datatable">
|
||||
<span id="id1"></span><h1>DataTable<a class="headerlink" href="#datatable" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class DataTable</p>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="output">
|
||||
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Dynamic DataTable</p>
|
||||
<img alt="../../../_images/Datatable.png" src="../../../_images/Datatable.png" />
|
||||
<p>Static DataTable</p>
|
||||
<img alt="../../../_images/DatatableStatic.png" src="../../../_images/DatatableStatic.png" />
|
||||
</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UIDataTable</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</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">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 66%" />
|
||||
<col style="width: 34%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#datatableforresult"><span class="std std-ref">ForResult</span></a></p></td>
|
||||
<td><p>@param WebPage $oPage</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#datatableforobject"><span class="std std-ref">ForObject</span></a></p></td>
|
||||
<td><p>@param WebPage $oPage</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#datatableforrendering"><span class="std std-ref">ForRendering</span></a></p></td>
|
||||
<td><p>Make a basis Panel component</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#datatableforrenderingobject"><span class="std std-ref">ForRenderingObject</span></a></p></td>
|
||||
<td><p>@param string $sListId</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#datatableforstaticdata"><span class="std std-ref">ForStaticData</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#datatableforform"><span class="std std-ref">ForForm</span></a></p></td>
|
||||
<td><p>@param string $sRef</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="datatable-forresult">
|
||||
<span id="datatableforresult"></span><h3>DataTable ForResult<a class="headerlink" href="#datatable-forresult" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orResult</span> <span class="o">{</span><span class="nv">oPage</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">sListId</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">oSet</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:</span><span class="nv">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">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 28%" />
|
||||
<col style="width: 26%" />
|
||||
<col style="width: 22%" />
|
||||
<col style="width: 20%" />
|
||||
<col style="width: 4%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>oPage</p></td>
|
||||
<td><p>WebPage</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sListId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>oSet</p></td>
|
||||
<td><p>DBObjectSet</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>aExtraParams</p></td>
|
||||
<td></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>array ()</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="datatable-forobject">
|
||||
<span id="datatableforobject"></span><h3>DataTable ForObject<a class="headerlink" href="#datatable-forobject" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orObject</span> <span class="o">{</span><span class="nv">oPage</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">sListId</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">oSet</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:</span><span class="nv">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">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 28%" />
|
||||
<col style="width: 26%" />
|
||||
<col style="width: 22%" />
|
||||
<col style="width: 20%" />
|
||||
<col style="width: 4%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>oPage</p></td>
|
||||
<td><p>WebPage</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sListId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>oSet</p></td>
|
||||
<td><p>DBObjectSet</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>aExtraParams</p></td>
|
||||
<td></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>array ()</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="datatable-forrendering">
|
||||
<span id="datatableforrendering"></span><h3>DataTable ForRendering<a class="headerlink" href="#datatable-forrendering" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orRendering</span> <span class="o">{</span><span class="nv">sListId</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">oSet</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:</span><span class="nv">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">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 28%" />
|
||||
<col style="width: 26%" />
|
||||
<col style="width: 22%" />
|
||||
<col style="width: 20%" />
|
||||
<col style="width: 4%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sListId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>oSet</p></td>
|
||||
<td><p>DBObjectSet</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>aExtraParams</p></td>
|
||||
<td></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>array ()</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="datatable-forrenderingobject">
|
||||
<span id="datatableforrenderingobject"></span><h3>DataTable ForRenderingObject<a class="headerlink" href="#datatable-forrenderingobject" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orRenderingObject</span> <span class="o">{</span><span class="nv">sListId</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">oSet</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:</span><span class="nv">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">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 28%" />
|
||||
<col style="width: 26%" />
|
||||
<col style="width: 22%" />
|
||||
<col style="width: 20%" />
|
||||
<col style="width: 4%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sListId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>oSet</p></td>
|
||||
<td><p>DBObjectSet</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>aExtraParams</p></td>
|
||||
<td></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>array ()</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="datatable-forstaticdata">
|
||||
<span id="datatableforstaticdata"></span><h3>DataTable ForStaticData<a class="headerlink" href="#datatable-forstaticdata" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orStaticData</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">aColumns</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">aData</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">sId</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">sFilter</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">aOptions</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">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">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 31%" />
|
||||
<col style="width: 18%" />
|
||||
<col style="width: 24%" />
|
||||
<col style="width: 22%" />
|
||||
<col style="width: 4%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>aColumns</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>aData</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>aExtraParams</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>array ()</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sFilter</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>aOptions</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>array ()</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="datatable-forform">
|
||||
<span id="datatableforform"></span><h3>DataTable ForForm<a class="headerlink" href="#datatable-forform" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orForm</span> <span class="o">{</span><span class="nv">sRef</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">aColumns</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">aData</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">sFilter</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">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 24%" />
|
||||
<col style="width: 20%" />
|
||||
<col style="width: 27%" />
|
||||
<col style="width: 24%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sRef</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>aColumns</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>aData</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>array ()</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sFilter</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="datatable-common-parameters">
|
||||
<h3>DataTable common parameters<a class="headerlink" href="#datatable-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 61%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddSubBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AjaxData</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AjaxUrl</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>DeferredBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DisplayColumns</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>JSRefresh</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Options</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>ResultColumns</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>SubBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr class="docutils" />
|
||||
<p>The columns (<em>aColumns</em>) have the following format:</p>
|
||||
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">[</span>
|
||||
<span class="x"> 'nameField1' => ['label' => labelField1, 'description' => descriptionField1],</span>
|
||||
<span class="x"> ...</span>
|
||||
<span class="x">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The data (<em>aData</em>) format has to be:</p>
|
||||
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">[</span>
|
||||
<span class="x"> ['nameField1' => valueField1, 'nameField2' => valueField2, ...],</span>
|
||||
<span class="x"> ...</span>
|
||||
<span class="x">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<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 navigation">
|
||||
|
||||
<a href="../Field/Field.html" class="btn btn-neutral float-right" title="Field" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../CollapsibleSection/CollapsibleSection.html" class="btn btn-neutral float-left" title="CollapsibleSection" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
663
.doc/UI/build/html/generated/Component/Field/Field.html
Normal file
663
.doc/UI/build/html/generated/Component/Field/Field.html
Normal file
@@ -0,0 +1,663 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Field — 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 type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="FieldBadge" href="../FieldBadge/FieldBadge.html" />
|
||||
<link rel="prev" title="DataTable" href="../DataTable/DataTable.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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 current"><a class="current reference internal" href="#">Field</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="#field-fromparams">Field FromParams</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#field-fromobject">Field FromObject</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#field-large">Field Large</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#field-small">Field Small</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#field-standard">Field Standard</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#field-common-parameters">Field 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="../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"><a class="reference internal" href="../Panel/Panel.html">Panel</a></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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>Field</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../_sources/generated/Component/Field/Field.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="field">
|
||||
<span id="id1"></span><h1>Field<a class="headerlink" href="#field" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class Field</p>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="output">
|
||||
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Example Fields</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<img alt="../../../_images/Field.png" src="../../../_images/Field.png" />
|
||||
</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UIField</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</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">EndUIField</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 76%" />
|
||||
<col style="width: 24%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#fieldfromparams"><span class="std std-ref">FromParams</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#fieldfromobject"><span class="std std-ref">FromObject</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#fieldlarge"><span class="std std-ref">Large</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#fieldsmall"><span class="std std-ref">Small</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#fieldstandard"><span class="std std-ref">Standard</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="field-fromparams">
|
||||
<span id="fieldfromparams"></span><h3>Field FromParams<a class="headerlink" href="#field-fromparams" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</span> <span class="p">F</span><span class="nv">romParams</span> <span class="o">{</span><span class="nv">aParams</span><span class="o">:</span><span class="nv">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">EndUIField</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 35%" />
|
||||
<col style="width: 8%" />
|
||||
<col style="width: 42%" />
|
||||
<col style="width: 8%" />
|
||||
<col style="width: 8%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>aParams</p></td>
|
||||
<td></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="field-fromobject">
|
||||
<span id="fieldfromobject"></span><h3>Field FromObject<a class="headerlink" href="#field-fromobject" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</span> <span class="p">F</span><span class="nv">romObject</span> <span class="o">{</span><span class="nv">sLabel</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">oInput</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">sLayout</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">EndUIField</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 24%" />
|
||||
<col style="width: 24%" />
|
||||
<col style="width: 30%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sLabel</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>oInput</p></td>
|
||||
<td><p>UIBlock</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sLayout</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="field-large">
|
||||
<span id="fieldlarge"></span><h3>Field Large<a class="headerlink" href="#field-large" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</span> <span class="p">L</span><span class="nv">arge</span> <span class="o">{</span><span class="nv">sLabel</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sValueHtml</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">EndUIField</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 32%" />
|
||||
<col style="width: 22%" />
|
||||
<col style="width: 30%" />
|
||||
<col style="width: 11%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sLabel</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sValueHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="field-small">
|
||||
<span id="fieldsmall"></span><h3>Field Small<a class="headerlink" href="#field-small" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</span> <span class="p">S</span><span class="nv">mall</span> <span class="o">{</span><span class="nv">sLabel</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sValueHtml</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">EndUIField</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 32%" />
|
||||
<col style="width: 22%" />
|
||||
<col style="width: 30%" />
|
||||
<col style="width: 11%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sLabel</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sValueHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="field-standard">
|
||||
<span id="fieldstandard"></span><h3>Field Standard<a class="headerlink" href="#field-standard" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sLabel</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sLayout</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUIField</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 24%" />
|
||||
<col style="width: 21%" />
|
||||
<col style="width: 26%" />
|
||||
<col style="width: 24%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sLabel</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘’</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sLayout</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘small’</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="field-common-parameters">
|
||||
<h3>Field common parameters<a class="headerlink" href="#field-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 61%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddSubBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AttCode</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AttLabel</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AttType</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Comments</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>DeferredBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>InputId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>InputType</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsMandatory</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsReadOnly</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsSlave</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>Label</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Layout</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>MustChange</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>MustPrompt</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>SubBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Value</p></td>
|
||||
<td><p>UIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>ValueId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>ValueRaw</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr class="docutils" />
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Related Tag</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="../FieldSet/FieldSet.html#fieldset"><span class="std std-ref">FieldSet</span></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="examples">
|
||||
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Example to generate a Field</p>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</span> <span class="p">S</span><span class="nv">mall</span> <span class="o">{</span><span class="nv">sLabel</span><span class="o">:</span> <span class="s2">"Product"</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||||
<span class="x"> iTop</span>
|
||||
<span class="cp">{%</span> <span class="k">EndUIField</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The result:</p>
|
||||
<img alt="../../../_images/Field.png" src="../../../_images/Field.png" />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="../FieldBadge/FieldBadge.html" class="btn btn-neutral float-right" title="FieldBadge" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../DataTable/DataTable.html" class="btn btn-neutral float-left" title="DataTable" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,404 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>FieldBadge — 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 type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="FieldSet" href="../FieldSet/FieldSet.html" />
|
||||
<link rel="prev" title="Field" href="../Field/Field.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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 current"><a class="current reference internal" href="#">FieldBadge</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="#fieldbadge-forfield">FieldBadge ForField</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#fieldbadge-common-parameters">FieldBadge 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="../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"><a class="reference internal" href="../Panel/Panel.html">Panel</a></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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>FieldBadge</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../_sources/generated/Component/FieldBadge/FieldBadge.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="fieldbadge">
|
||||
<span id="id1"></span><h1>FieldBadge<a class="headerlink" href="#fieldbadge" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class FieldBadge</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UIFieldBadge</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIFieldBadge</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">EndUIFieldBadge</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 62%" />
|
||||
<col style="width: 38%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#fieldbadgeforfield"><span class="std std-ref">ForField</span></a></p></td>
|
||||
<td><p>@param string $sValue</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="fieldbadge-forfield">
|
||||
<span id="fieldbadgeforfield"></span><h3>FieldBadge ForField<a class="headerlink" href="#fieldbadge-forfield" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIFieldBadge</span> <span class="p">F</span><span class="nv">orField</span> <span class="o">{</span><span class="nv">sValue</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">oStyle</span><span class="o">:</span><span class="nv">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">EndUIFieldBadge</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 24%" />
|
||||
<col style="width: 30%" />
|
||||
<col style="width: 33%" />
|
||||
<col style="width: 6%" />
|
||||
<col style="width: 6%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sValue</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>oStyle</p></td>
|
||||
<td><p>ormStyle</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="fieldbadge-common-parameters">
|
||||
<h3>FieldBadge common parameters<a class="headerlink" href="#fieldbadge-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 61%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddSubBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>DeferredBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>SubBlocks</p></td>
|
||||
<td><p>array</p></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 navigation">
|
||||
|
||||
<a href="../FieldSet/FieldSet.html" class="btn btn-neutral float-right" title="FieldSet" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../Field/Field.html" class="btn btn-neutral float-left" title="Field" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
422
.doc/UI/build/html/generated/Component/FieldSet/FieldSet.html
Normal file
422
.doc/UI/build/html/generated/Component/FieldSet/FieldSet.html
Normal file
@@ -0,0 +1,422 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>FieldSet — 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 type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="Form" href="../Form/Form.html" />
|
||||
<link rel="prev" title="FieldBadge" href="../FieldBadge/FieldBadge.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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 current"><a class="current reference internal" href="#">FieldSet</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="#fieldset-standard">FieldSet Standard</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#fieldset-common-parameters">FieldSet 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="../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"><a class="reference internal" href="../Panel/Panel.html">Panel</a></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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>FieldSet</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../_sources/generated/Component/FieldSet/FieldSet.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="fieldset">
|
||||
<span id="id1"></span><h1>FieldSet<a class="headerlink" href="#fieldset" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class FieldSet</p>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="output">
|
||||
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Example FieldSets</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<img alt="../../../_images/FieldSet.png" src="../../../_images/FieldSet.png" />
|
||||
</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UIFieldSet</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIFieldSet</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">EndUIFieldSet</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 75%" />
|
||||
<col style="width: 25%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#fieldsetstandard"><span class="std std-ref">Standard</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="fieldset-standard">
|
||||
<span id="fieldsetstandard"></span><h3>FieldSet Standard<a class="headerlink" href="#fieldset-standard" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIFieldSet</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sLegend</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUIFieldSet</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 25%" />
|
||||
<col style="width: 22%" />
|
||||
<col style="width: 31%" />
|
||||
<col style="width: 17%" />
|
||||
<col style="width: 6%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sLegend</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="fieldset-common-parameters">
|
||||
<h3>FieldSet common parameters<a class="headerlink" href="#fieldset-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 61%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddSubBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>DeferredBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>SubBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr class="docutils" />
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Related Tag</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="../Field/Field.html#field"><span class="std std-ref">Field</span></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="examples">
|
||||
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Example to generate a FieldSet:</p>
|
||||
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">{% UIFieldSet Standard {sLegend: "iTop environment"} %}</span>
|
||||
<span class="x"> {% UIField ... %}</span>
|
||||
<span class="x"> ...</span>
|
||||
<span class="x">{% EndUIFieldSet %}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The result:</p>
|
||||
<img alt="../../../_images/FieldSet-explained.png" src="../../../_images/FieldSet-explained.png" />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="../Form/Form.html" class="btn btn-neutral float-right" title="Form" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../FieldBadge/FieldBadge.html" class="btn btn-neutral float-left" title="FieldBadge" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
406
.doc/UI/build/html/generated/Component/Form/Form.html
Normal file
406
.doc/UI/build/html/generated/Component/Form/Form.html
Normal file
@@ -0,0 +1,406 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Form — 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 type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="FileSelect" href="../Input/FileSelect/FileSelect.html" />
|
||||
<link rel="prev" title="FieldSet" href="../FieldSet/FieldSet.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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 current"><a class="current reference internal" href="#">Form</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="#form-standard">Form Standard</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#form-common-parameters">Form 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="../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"><a class="reference internal" href="../Panel/Panel.html">Panel</a></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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>Form</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../_sources/generated/Component/Form/Form.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="form">
|
||||
<span id="id1"></span><h1>Form<a class="headerlink" href="#form" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class Form</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UIForm</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIForm</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">EndUIForm</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 73%" />
|
||||
<col style="width: 27%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#formstandard"><span class="std std-ref">Standard</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="form-standard">
|
||||
<span id="formstandard"></span><h3>Form Standard<a class="headerlink" href="#form-standard" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIForm</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sId</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">EndUIForm</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 26%" />
|
||||
<col style="width: 32%" />
|
||||
<col style="width: 19%" />
|
||||
<col style="width: 6%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="form-common-parameters">
|
||||
<h3>Form common parameters<a class="headerlink" href="#form-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 61%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>Action</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddDeferredBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddSubBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DeferredBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>OnSubmitJsCode</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>SubBlocks</p></td>
|
||||
<td><p>array</p></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 navigation">
|
||||
|
||||
<a href="../Input/FileSelect/FileSelect.html" class="btn btn-neutral float-right" title="FileSelect" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../FieldSet/FieldSet.html" class="btn btn-neutral float-left" title="FieldSet" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,396 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>FileSelect — 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 type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="Input" href="../Input.html" />
|
||||
<link rel="prev" title="Form" href="../../Form/Form.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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 current"><a class="current reference internal" href="#">FileSelect</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="#fileselect-standard">FileSelect Standard</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#fileselect-common-parameters">FileSelect 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="../Input.html">Input</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../Select/Select.html">Select</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../Select/SelectOption.html">SelectOption</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../Panel/Panel.html">Panel</a></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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>FileSelect</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../../_sources/generated/Component/Input/FileSelect/FileSelect.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="fileselect">
|
||||
<span id="id1"></span><h1>FileSelect<a class="headerlink" href="#fileselect" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class FileSelect</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UIFileSelect</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIFileSelect</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>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 76%" />
|
||||
<col style="width: 24%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#fileselectstandard"><span class="std std-ref">Standard</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="fileselect-standard">
|
||||
<span id="fileselectstandard"></span><h3>FileSelect Standard<a class="headerlink" href="#fileselect-standard" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIFileSelect</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sName</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 21%" />
|
||||
<col style="width: 24%" />
|
||||
<col style="width: 32%" />
|
||||
<col style="width: 18%" />
|
||||
<col style="width: 6%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sName</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="fileselect-common-parameters">
|
||||
<h3>FileSelect common parameters<a class="headerlink" href="#fileselect-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 30%" />
|
||||
<col style="width: 8%" />
|
||||
<col style="width: 62%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>ButtonText</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>FileName</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>ShowFilename</p></td>
|
||||
<td><p>bool</p></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 navigation">
|
||||
|
||||
<a href="../Input.html" class="btn btn-neutral float-right" title="Input" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../../Form/Form.html" class="btn btn-neutral float-left" title="Form" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
530
.doc/UI/build/html/generated/Component/Input/Input.html
Normal file
530
.doc/UI/build/html/generated/Component/Input/Input.html
Normal file
@@ -0,0 +1,530 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Input — 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 type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="Select" href="Select/Select.html" />
|
||||
<link rel="prev" title="FileSelect" href="FileSelect/FileSelect.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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="FileSelect/FileSelect.html">FileSelect</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Input</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="#input-forhidden">Input ForHidden</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#input-standard">Input Standard</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#input-forinputwithlabel">Input ForInputWithLabel</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#input-common-parameters">Input 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="Select/Select.html">Select</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Select/SelectOption.html">SelectOption</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../Panel/Panel.html">Panel</a></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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>Input</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../_sources/generated/Component/Input/Input.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="input">
|
||||
<span id="id1"></span><h1>Input<a class="headerlink" href="#input" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class Input</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UIInput</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIInput</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>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 38%" />
|
||||
<col style="width: 62%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#inputforhidden"><span class="std std-ref">ForHidden</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#inputstandard"><span class="std std-ref">Standard</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#inputforinputwithlabel"><span class="std std-ref">ForInputWithLabel</span></a></p></td>
|
||||
<td><p>@see Field component that is better adapter when dealing with a standard iTop form</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="input-forhidden">
|
||||
<span id="inputforhidden"></span><h3>Input ForHidden<a class="headerlink" href="#input-forhidden" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIInput</span> <span class="p">F</span><span class="nv">orHidden</span> <span class="o">{</span><span class="nv">sName</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sValue</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 23%" />
|
||||
<col style="width: 23%" />
|
||||
<col style="width: 31%" />
|
||||
<col style="width: 17%" />
|
||||
<col style="width: 6%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sName</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sValue</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="input-standard">
|
||||
<span id="inputstandard"></span><h3>Input Standard<a class="headerlink" href="#input-standard" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIInput</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sType</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sName</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sValue</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 23%" />
|
||||
<col style="width: 23%" />
|
||||
<col style="width: 31%" />
|
||||
<col style="width: 17%" />
|
||||
<col style="width: 6%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sType</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sName</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sValue</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="input-forinputwithlabel">
|
||||
<span id="inputforinputwithlabel"></span><h3>Input ForInputWithLabel<a class="headerlink" href="#input-forinputwithlabel" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIInput</span> <span class="p">F</span><span class="nv">orInputWithLabel</span> <span class="o">{</span><span class="nv">sLabel</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sInputName</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sInputValue</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sInputId</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sInputType</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 31%" />
|
||||
<col style="width: 19%" />
|
||||
<col style="width: 26%" />
|
||||
<col style="width: 19%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sLabel</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sInputName</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sInputValue</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sInputId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sInputType</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘type’</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="input-common-parameters">
|
||||
<h3>Input common parameters<a class="headerlink" href="#input-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 30%" />
|
||||
<col style="width: 8%" />
|
||||
<col style="width: 62%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsChecked</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsDisabled</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsReadonly</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Name</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>Placeholder</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Type</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>Value</p></td>
|
||||
<td><p>string</p></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 navigation">
|
||||
|
||||
<a href="Select/Select.html" class="btn btn-neutral float-right" title="Select" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="FileSelect/FileSelect.html" class="btn btn-neutral float-left" title="FileSelect" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
477
.doc/UI/build/html/generated/Component/Input/Select/Select.html
Normal file
477
.doc/UI/build/html/generated/Component/Input/Select/Select.html
Normal file
@@ -0,0 +1,477 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Select — 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 type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="SelectOption" href="SelectOption.html" />
|
||||
<link rel="prev" title="Input" href="../Input.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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="../FileSelect/FileSelect.html">FileSelect</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../Input.html">Input</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Select</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="#select-forselect">Select ForSelect</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#select-forselectwithlabel">Select ForSelectWithLabel</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#select-common-parameters">Select 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="SelectOption.html">SelectOption</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../Panel/Panel.html">Panel</a></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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>Select</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../../_sources/generated/Component/Input/Select/Select.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="select">
|
||||
<span id="id1"></span><h1>Select<a class="headerlink" href="#select" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class Select</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UISelect</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISelect</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">EndUISelect</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 60%" />
|
||||
<col style="width: 40%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#selectforselect"><span class="std std-ref">ForSelect</span></a></p></td>
|
||||
<td><p>Create a default Select input</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#selectforselectwithlabel"><span class="std std-ref">ForSelectWithLabel</span></a></p></td>
|
||||
<td><p>Create a Select input with a label</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="select-forselect">
|
||||
<span id="selectforselect"></span><h3>Select ForSelect<a class="headerlink" href="#select-forselect" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISelect</span> <span class="p">F</span><span class="nv">orSelect</span> <span class="o">{</span><span class="nv">sName</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUISelect</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 12%" />
|
||||
<col style="width: 14%" />
|
||||
<col style="width: 19%" />
|
||||
<col style="width: 11%" />
|
||||
<col style="width: 44%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sName</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td><p>Input name for the form</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td><p>$sId</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="select-forselectwithlabel">
|
||||
<span id="selectforselectwithlabel"></span><h3>Select ForSelectWithLabel<a class="headerlink" href="#select-forselectwithlabel" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISelect</span> <span class="p">F</span><span class="nv">orSelectWithLabel</span> <span class="o">{</span><span class="nv">sName</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sLabel</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUISelect</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 9%" />
|
||||
<col style="width: 9%" />
|
||||
<col style="width: 13%" />
|
||||
<col style="width: 7%" />
|
||||
<col style="width: 62%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sName</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td><p>Input name for the form</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sLabel</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td><p>Label to display with the input (null for no label)</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td><p>$sId</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="select-common-parameters">
|
||||
<h3>Select common parameters<a class="headerlink" href="#select-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 28%" />
|
||||
<col style="width: 14%" />
|
||||
<col style="width: 58%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddOption</p></td>
|
||||
<td><p>SelectOption</p></td>
|
||||
<td><p>Select option UIBlock</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddSubBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DeferredBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsLabelBefore</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>If true the label will be positioned before the input</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsMultiple</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Allow multiple selection</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>Label</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>Label to display with the input (null for no label)</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Name</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>Input name for the form</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>SubBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>SubmitOnChange</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>if true submit the form as soon as a change is detected</p></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 navigation">
|
||||
|
||||
<a href="SelectOption.html" class="btn btn-neutral float-right" title="SelectOption" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../Input.html" class="btn btn-neutral float-left" title="Input" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,412 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>SelectOption — 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 type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="Panel" href="../../Panel/Panel.html" />
|
||||
<link rel="prev" title="Select" href="Select.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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="../FileSelect/FileSelect.html">FileSelect</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../Input.html">Input</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Select.html">Select</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">SelectOption</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="#selectoption-forselectoption">SelectOption ForSelectOption</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#selectoption-common-parameters">SelectOption 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="../../Panel/Panel.html">Panel</a></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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>SelectOption</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../../_sources/generated/Component/Input/Select/SelectOption.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="selectoption">
|
||||
<span id="id1"></span><h1>SelectOption<a class="headerlink" href="#selectoption" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class SelectOption</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UISelectOption</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISelectOption</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>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 82%" />
|
||||
<col style="width: 18%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#selectoptionforselectoption"><span class="std std-ref">ForSelectOption</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="selectoption-forselectoption">
|
||||
<span id="selectoptionforselectoption"></span><h3>SelectOption ForSelectOption<a class="headerlink" href="#selectoption-forselectoption" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISelectOption</span> <span class="p">F</span><span class="nv">orSelectOption</span> <span class="o">{</span><span class="nv">sValue</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sLabel</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">bSelected</span><span class="o">:</span><span class="kp">true</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 21%" />
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sValue</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sLabel</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>bSelected</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="selectoption-common-parameters">
|
||||
<h3>SelectOption common parameters<a class="headerlink" href="#selectoption-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 30%" />
|
||||
<col style="width: 8%" />
|
||||
<col style="width: 62%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Disabled</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Label</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>Selected</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Value</p></td>
|
||||
<td><p>string</p></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 navigation">
|
||||
|
||||
<a href="../../Panel/Panel.html" class="btn btn-neutral float-right" title="Panel" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="Select.html" class="btn btn-neutral float-left" title="Select" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
830
.doc/UI/build/html/generated/Component/Panel/Panel.html
Normal file
830
.doc/UI/build/html/generated/Component/Panel/Panel.html
Normal file
@@ -0,0 +1,830 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" 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 type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UIPanel</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 52%" />
|
||||
<col style="width: 48%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#panelneutral"><span class="std std-ref">Neutral</span></a></p></td>
|
||||
<td><p>Make a basis Panel component</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#panelforinformation"><span class="std std-ref">ForInformation</span></a></p></td>
|
||||
<td><p>Make a Panel component for informational messages</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#panelforsuccess"><span class="std std-ref">ForSuccess</span></a></p></td>
|
||||
<td><p>Make a Panel component for successful messages</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#panelforwarning"><span class="std std-ref">ForWarning</span></a></p></td>
|
||||
<td><p>Make a Panel component for warning messages</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#panelfordanger"><span class="std std-ref">ForDanger</span></a></p></td>
|
||||
<td><p>Make a Panel component for danger messages</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#panelforfailure"><span class="std std-ref">ForFailure</span></a></p></td>
|
||||
<td><p>Make a Panel component for failure messages</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#panelwithbrandingprimarycolor"><span class="std std-ref">WithBrandingPrimaryColor</span></a></p></td>
|
||||
<td><p>Make a Panel component with primary color scheme</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#panelwithbrandingsecondarycolor"><span class="std std-ref">WithBrandingSecondaryColor</span></a></p></td>
|
||||
<td><p>Make a Panel component with secondary color scheme</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#panelforclass"><span class="std std-ref">ForClass</span></a></p></td>
|
||||
<td><p>Make a Panel component with the specific $sClass color scheme</p></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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 21%" />
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sSubTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 21%" />
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sSubTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 21%" />
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sSubTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 21%" />
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sSubTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 21%" />
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sSubTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 21%" />
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sSubTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 21%" />
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sSubTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 21%" />
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 5%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sSubTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 15%" />
|
||||
<col style="width: 11%" />
|
||||
<col style="width: 15%" />
|
||||
<col style="width: 8%" />
|
||||
<col style="width: 51%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td><p>Class of the object the panel is for</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sSubTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></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 class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 27%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 57%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMainBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMainBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddSubBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddSubTitleBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddSubTitleBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddTitleBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddTitleBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddToolbarBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddToolbarBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>Color</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>ColorFromClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>ColorFromOrmStyle</p></td>
|
||||
<td><p>ormStyle</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DeferredBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsCollapsible</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsHeaderVisibleOnScroll</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>MainBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>SubBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>SubTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>SubTitleBlock</p></td>
|
||||
<td><p>iUIContentBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>Title</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>TitleBlock</p></td>
|
||||
<td><p>iUIContentBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>ToolBlocks</p></td>
|
||||
<td><p>array</p></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 navigation">
|
||||
|
||||
<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"></span></a>
|
||||
|
||||
|
||||
<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"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
378
.doc/UI/build/html/generated/Component/Spinner/Spinner.html
Normal file
378
.doc/UI/build/html/generated/Component/Spinner/Spinner.html
Normal file
@@ -0,0 +1,378 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Spinner — 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 type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="Title" href="../Title/Title.html" />
|
||||
<link rel="prev" title="Panel" href="../Panel/Panel.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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"><a class="reference internal" href="../Panel/Panel.html">Panel</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Spinner</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="#spinner-standard">Spinner Standard</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#spinner-common-parameters">Spinner 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="../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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>Spinner</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../_sources/generated/Component/Spinner/Spinner.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="spinner">
|
||||
<span id="id1"></span><h1>Spinner<a class="headerlink" href="#spinner" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class Spinner</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UISpinner</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISpinner</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>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 74%" />
|
||||
<col style="width: 26%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#spinnerstandard"><span class="std std-ref">Standard</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="spinner-standard">
|
||||
<span id="spinnerstandard"></span><h3>Spinner Standard<a class="headerlink" href="#spinner-standard" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISpinner</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sId</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 26%" />
|
||||
<col style="width: 32%" />
|
||||
<col style="width: 19%" />
|
||||
<col style="width: 6%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="spinner-common-parameters">
|
||||
<h3>Spinner common parameters<a class="headerlink" href="#spinner-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 30%" />
|
||||
<col style="width: 8%" />
|
||||
<col style="width: 62%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></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 navigation">
|
||||
|
||||
<a href="../Title/Title.html" class="btn btn-neutral float-right" title="Title" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../Panel/Panel.html" class="btn btn-neutral float-left" title="Panel" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
574
.doc/UI/build/html/generated/Component/Title/Title.html
Normal file
574
.doc/UI/build/html/generated/Component/Title/Title.html
Normal file
@@ -0,0 +1,574 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Title — 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 type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="Toolbar" href="../Toolbar/Toolbar.html" />
|
||||
<link rel="prev" title="Spinner" href="../Spinner/Spinner.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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"><a class="reference internal" href="../Panel/Panel.html">Panel</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../Spinner/Spinner.html">Spinner</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Title</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="#title-forpage">Title ForPage</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#title-forpagewithicon">Title ForPageWithIcon</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#title-neutral">Title Neutral</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#title-standard">Title Standard</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#title-common-parameters">Title 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="../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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>Title</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../_sources/generated/Component/Title/Title.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="title">
|
||||
<span id="id1"></span><h1>Title<a class="headerlink" href="#title" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class Title</p>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="output">
|
||||
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline">¶</a></h2>
|
||||
<img alt="../../../_images/Title.png" src="../../../_images/Title.png" />
|
||||
</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UITitle</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UITitle</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">EndUITitle</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 80%" />
|
||||
<col style="width: 20%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#titleforpage"><span class="std std-ref">ForPage</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#titleforpagewithicon"><span class="std std-ref">ForPageWithIcon</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#titleneutral"><span class="std std-ref">Neutral</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#titlestandard"><span class="std std-ref">Standard</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="title-forpage">
|
||||
<span id="titleforpage"></span><h3>Title ForPage<a class="headerlink" href="#title-forpage" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UITitle</span> <span class="p">F</span><span class="nv">orPage</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</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">EndUITitle</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 23%" />
|
||||
<col style="width: 23%" />
|
||||
<col style="width: 31%" />
|
||||
<col style="width: 17%" />
|
||||
<col style="width: 6%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="title-forpagewithicon">
|
||||
<span id="titleforpagewithicon"></span><h3>Title ForPageWithIcon<a class="headerlink" href="#title-forpagewithicon" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UITitle</span> <span class="p">F</span><span class="nv">orPageWithIcon</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sIconUrl</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sIconCoverMethod</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">bIsMedallion</span><span class="o">:</span><span class="kp">true</span><span class="o">,</span> <span class="nv">sId</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">EndUITitle</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 36%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 22%" />
|
||||
<col style="width: 22%" />
|
||||
<col style="width: 4%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>sIconUrl</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sIconCoverMethod</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>‘contain’</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>bIsMedallion</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>true</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="title-neutral">
|
||||
<span id="titleneutral"></span><h3>Title Neutral<a class="headerlink" href="#title-neutral" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UITitle</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">iLevel</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">sId</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">EndUITitle</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 23%" />
|
||||
<col style="width: 23%" />
|
||||
<col style="width: 31%" />
|
||||
<col style="width: 17%" />
|
||||
<col style="width: 6%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sTitle</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>iLevel</p></td>
|
||||
<td><p>int</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>1</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="title-standard">
|
||||
<span id="titlestandard"></span><h3>Title Standard<a class="headerlink" href="#title-standard" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UITitle</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">oTitle</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">iLevel</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">sId</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">EndUITitle</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 22%" />
|
||||
<col style="width: 25%" />
|
||||
<col style="width: 31%" />
|
||||
<col style="width: 17%" />
|
||||
<col style="width: 6%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>oTitle</p></td>
|
||||
<td><p>UIBlock</p></td>
|
||||
<td><p>mandatory</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>iLevel</p></td>
|
||||
<td><p>int</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>1</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="title-common-parameters">
|
||||
<h3>Title common parameters<a class="headerlink" href="#title-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 61%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddSubBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>DeferredBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>SubBlocks</p></td>
|
||||
<td><p>array</p></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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">The following code</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UITitle</span> <span class="p">F</span><span class="nv">orPage</span> <span class="o">{</span><span class="nv">sTitle</span><span class="o">:</span> <span class="s1">'UI:FullTextSearchTitle_Text'</span><span class="o">|</span><span class="nf">dict_format</span><span class="o">(</span><span class="nv">sFullText</span><span class="o">)}</span> <span class="cp">%}{%</span> <span class="k">EndUITitle</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Will display</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<img alt="../../../_images/Title.png" src="../../../_images/Title.png" />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="../Toolbar/Toolbar.html" class="btn btn-neutral float-right" title="Toolbar" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../Spinner/Spinner.html" class="btn btn-neutral float-left" title="Spinner" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
484
.doc/UI/build/html/generated/Component/Toolbar/Toolbar.html
Normal file
484
.doc/UI/build/html/generated/Component/Toolbar/Toolbar.html
Normal file
@@ -0,0 +1,484 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Toolbar — 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 type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="ToolbarSpacer" href="ToolbarSpacer/ToolbarSpacer.html" />
|
||||
<link rel="prev" title="Title" href="../Title/Title.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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"><a class="reference internal" href="../Panel/Panel.html">Panel</a></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 current"><a class="current reference internal" href="#">Toolbar</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="#toolbar-foraction">Toolbar ForAction</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#toolbar-standard">Toolbar Standard</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#toolbar-forbutton">Toolbar ForButton</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#toolbar-common-parameters">Toolbar 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="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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>Toolbar</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../_sources/generated/Component/Toolbar/Toolbar.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="toolbar">
|
||||
<span id="id1"></span><h1>Toolbar<a class="headerlink" href="#toolbar" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class Toolbar</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UIToolbar</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIToolbar</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">EndUIToolbar</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 76%" />
|
||||
<col style="width: 24%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#toolbarforaction"><span class="std std-ref">ForAction</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#toolbarstandard"><span class="std std-ref">Standard</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#toolbarforbutton"><span class="std std-ref">ForButton</span></a></p></td>
|
||||
<td><p>No comment</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="toolbar-foraction">
|
||||
<span id="toolbarforaction"></span><h3>Toolbar ForAction<a class="headerlink" href="#toolbar-foraction" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIToolbar</span> <span class="p">F</span><span class="nv">orAction</span> <span class="o">{</span><span class="nv">sId</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">EndUIToolbar</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 26%" />
|
||||
<col style="width: 32%" />
|
||||
<col style="width: 19%" />
|
||||
<col style="width: 6%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="toolbar-standard">
|
||||
<span id="toolbarstandard"></span><h3>Toolbar Standard<a class="headerlink" href="#toolbar-standard" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIToolbar</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sId</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">aContainerClasses</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">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">EndUIToolbar</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 39%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 20%" />
|
||||
<col style="width: 20%" />
|
||||
<col style="width: 4%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>aContainerClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>array ()</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="toolbar-forbutton">
|
||||
<span id="toolbarforbutton"></span><h3>Toolbar ForButton<a class="headerlink" href="#toolbar-forbutton" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIToolbar</span> <span class="p">F</span><span class="nv">orButton</span> <span class="o">{</span><span class="nv">sId</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">aContainerClasses</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">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">EndUIToolbar</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 39%" />
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 20%" />
|
||||
<col style="width: 20%" />
|
||||
<col style="width: 4%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>aContainerClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>array ()</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="toolbar-common-parameters">
|
||||
<h3>Toolbar common parameters<a class="headerlink" href="#toolbar-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 61%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddSubBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>DeferredBlocks</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>SubBlocks</p></td>
|
||||
<td><p>array</p></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 navigation">
|
||||
|
||||
<a href="ToolbarSpacer/ToolbarSpacer.html" class="btn btn-neutral float-right" title="ToolbarSpacer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../Title/Title.html" class="btn btn-neutral float-left" title="Title" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,378 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>ToolbarSpacer — 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 type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" 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="UI Layouts" href="../../../Layout/Layout.html" />
|
||||
<link rel="prev" title="Toolbar" href="../Toolbar.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" alt="Documentation 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="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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"><a class="reference internal" href="../../Panel/Panel.html">Panel</a></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.html">Toolbar</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">ToolbarSpacer</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="#toolbarspacer-standard">ToolbarSpacer Standard</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#toolbarspacer-common-parameters">ToolbarSpacer common parameters</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li>
|
||||
</ul>
|
||||
</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="top navigation">
|
||||
|
||||
<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="breadcrumbs 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>ToolbarSpacer</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="../../../../_sources/generated/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.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="toolbarspacer">
|
||||
<span id="id1"></span><h1>ToolbarSpacer<a class="headerlink" href="#toolbarspacer" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Class ButtonToolbarSpacer</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Tag</dt>
|
||||
<dd class="field-odd"><p><strong>UIToolbarSpacer</strong></p>
|
||||
</dd>
|
||||
<dt class="field-even">Syntax</dt>
|
||||
<dd class="field-even"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIToolbarSpacer</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>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Type</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 62%" />
|
||||
<col style="width: 38%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#toolbarspacerstandard"><span class="std std-ref">Standard</span></a></p></td>
|
||||
<td><p>@param string|null $sId</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section" id="toolbarspacer-standard">
|
||||
<span id="toolbarspacerstandard"></span><h3>ToolbarSpacer Standard<a class="headerlink" href="#toolbarspacer-standard" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">syntax</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIToolbarSpacer</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sId</span><span class="s1">:'value'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">parameters</dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 16%" />
|
||||
<col style="width: 26%" />
|
||||
<col style="width: 32%" />
|
||||
<col style="width: 19%" />
|
||||
<col style="width: 6%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>sId</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>optional</p></td>
|
||||
<td><p>NULL</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="toolbarspacer-common-parameters">
|
||||
<h3>ToolbarSpacer common parameters<a class="headerlink" href="#toolbarspacer-common-parameters" title="Permalink to this headline">¶</a></h3>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 30%" />
|
||||
<col style="width: 8%" />
|
||||
<col style="width: 62%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddCSSClass</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>CSS class to add to the generated html block</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>DataAttributes</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td><p>Array of data attributes in the format [‘name’ => ‘value’]</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>IsHidden</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Indicates if the block is hidden by default</p></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 navigation">
|
||||
|
||||
<a href="../../../Layout/Layout.html" class="btn btn-neutral float-right" title="UI Layouts" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="../Toolbar.html" class="btn btn-neutral float-left" title="Toolbar" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, Combodo
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user