Files
iTop/.doc/UI/build/html/generated/Component/Input/Select/SelectOption.html
2021-10-08 16:44:38 +02:00

299 lines
13 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>SelectOption &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.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 data-url_root="../../../../" id="documentation_options" 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/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"> iTop UI
<img src="../../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><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>
</ul>
<p class="caption" role="heading"><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="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../Component.html">UI Components</a> &raquo;</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">
<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" />
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>No output provided yet</p>
</section>
<hr class="docutils" />
<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>
<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">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sLabel</span><span class="s1">:&#39;value&#39;</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">:&#39;value&#39;</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>
</section>
<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 &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</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 &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</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 =&gt; 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" />
</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="Select.html" class="btn btn-neutral float-left" title="Select" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<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" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>