mirror of
https://github.com/Combodo/iTop.git
synced 2026-04-25 11:38:44 +02:00
385 lines
16 KiB
HTML
385 lines
16 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html4" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>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 id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
|
||
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
|
||
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
|
||
<script type="text/javascript" src="../../../../_static/language_data.js"></script>
|
||
<script src="../../../../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||
<link rel="search" title="Search" href="../../../../search.html" />
|
||
<link rel="next" title="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"> iTop UI<img src="../../../../_static/itop-logo.png" class="logo" alt="Logo"/>
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption"><span class="caption-text">Twig Base:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
|
||
</ul>
|
||
<p class="caption"><span class="caption-text">Tags reference:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="../../Component.html">UI Components</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="../../Alert/Alert.html">Alert</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../Button/Button.html">Button</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../ButtonGroup/ButtonGroup.html">ButtonGroup</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../CollapsibleSection/CollapsibleSection.html">CollapsibleSection</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../DataTable/DataTable.html">DataTable</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../Field/Field.html">Field</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../FieldBadge/FieldBadge.html">FieldBadge</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../FieldSet/FieldSet.html">FieldSet</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../Form/Form.html">Form</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../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="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../../../../index.html">iTop UI</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../../../../index.html" class="icon icon-home"></a> »</li>
|
||
<li><a href="../../Component.html">UI Components</a> »</li>
|
||
<li>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>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UISelect</strong></td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">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>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="60%" />
|
||
<col width="40%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td><a class="reference internal" href="#selectforselect"><span class="std std-ref">ForSelect</span></a></td>
|
||
<td>Create a default Select input</td>
|
||
</tr>
|
||
<tr class="row-even"><td><a class="reference internal" href="#selectforselectwithlabel"><span class="std std-ref">ForSelectWithLabel</span></a></td>
|
||
<td>Create a Select input with a label</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>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">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>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="12%" />
|
||
<col width="14%" />
|
||
<col width="19%" />
|
||
<col width="11%" />
|
||
<col width="44%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td>sName</td>
|
||
<td>string</td>
|
||
<td>mandatory</td>
|
||
<td> </td>
|
||
<td>Input name for the form</td>
|
||
</tr>
|
||
<tr class="row-even"><td>sId</td>
|
||
<td>string</td>
|
||
<td>optional</td>
|
||
<td>NULL</td>
|
||
<td>$sId</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>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">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>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="9%" />
|
||
<col width="9%" />
|
||
<col width="13%" />
|
||
<col width="7%" />
|
||
<col width="62%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td>sName</td>
|
||
<td>string</td>
|
||
<td>mandatory</td>
|
||
<td> </td>
|
||
<td>Input name for the form</td>
|
||
</tr>
|
||
<tr class="row-even"><td>sLabel</td>
|
||
<td>string</td>
|
||
<td>mandatory</td>
|
||
<td> </td>
|
||
<td>Label to display with the input (null for no label)</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>sId</td>
|
||
<td>string</td>
|
||
<td>optional</td>
|
||
<td>NULL</td>
|
||
<td>$sId</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 border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="28%" />
|
||
<col width="14%" />
|
||
<col width="58%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td>AddCSSClass</td>
|
||
<td>string</td>
|
||
<td>CSS class to add to the generated html block</td>
|
||
</tr>
|
||
<tr class="row-even"><td>AddCSSClasses</td>
|
||
<td>array</td>
|
||
<td>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></td>
|
||
</tr>
|
||
<tr class="row-odd"><td>AddCssFileRelPath</td>
|
||
<td>string</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>AddDeferredBlock</td>
|
||
<td>iUIBlock</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>AddHtml</td>
|
||
<td>string</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>AddJsFileRelPath</td>
|
||
<td>string</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>AddOption</td>
|
||
<td>SelectOption</td>
|
||
<td>Select option UIBlock</td>
|
||
</tr>
|
||
<tr class="row-even"><td>AddSubBlock</td>
|
||
<td>iUIBlock</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>CSSClasses</td>
|
||
<td>array</td>
|
||
<td>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></td>
|
||
</tr>
|
||
<tr class="row-even"><td>DataAttributes</td>
|
||
<td>array</td>
|
||
<td>Array of data attributes in the format [‘name’ => ‘value’]</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>DeferredBlocks</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>IsHidden</td>
|
||
<td>bool</td>
|
||
<td>Indicates if the block is hidden by default</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>IsLabelBefore</td>
|
||
<td>bool</td>
|
||
<td>If true the label will be positioned before the input</td>
|
||
</tr>
|
||
<tr class="row-even"><td>IsMultiple</td>
|
||
<td>bool</td>
|
||
<td>Allow multiple selection</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>Label</td>
|
||
<td>string</td>
|
||
<td>Label to display with the input (null for no label)</td>
|
||
</tr>
|
||
<tr class="row-even"><td>Name</td>
|
||
<td>string</td>
|
||
<td>Input name for the form</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>SubBlocks</td>
|
||
<td>array</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>SubmitOnChange</td>
|
||
<td>bool</td>
|
||
<td>if true submit the form as soon as a change is detected</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="examples">
|
||
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
|
||
<p>No examples provided yet</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="../Input.html" class="btn btn-neutral float-left" title="Input" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="SelectOption.html" class="btn btn-neutral float-right" title="SelectOption" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2021, Combodo.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |