mirror of
https://github.com/Combodo/iTop.git
synced 2026-04-25 19:48:49 +02:00
Doc update
This commit is contained in:
Eric Espie
@@ -1,19 +1,21 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html4" lang="en" >
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<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>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" />
|
||||
<title>ButtonGroup — 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 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 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" />
|
||||
@@ -26,7 +28,8 @@
|
||||
<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 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">
|
||||
@@ -36,13 +39,13 @@
|
||||
</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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
@@ -102,169 +105,154 @@
|
||||
<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>
|
||||
<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>
|
||||
<section id="output">
|
||||
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
|
||||
<p>No output provided yet</p>
|
||||
</div>
|
||||
</section>
|
||||
<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>UIButtonGroup</strong></td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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>
|
||||
<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">
|
||||
<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 width="40%" />
|
||||
<col width="60%" />
|
||||
<col style="width: 40%" />
|
||||
<col style="width: 60%" />
|
||||
</colgroup>
|
||||
<tbody valign="top">
|
||||
<tr class="row-odd"><td><a class="reference internal" href="#buttongroupbuttonwithoptionsmenu"><span class="std std-ref">ButtonWithOptionsMenu</span></a></td>
|
||||
<td>Make a button that has a primary action ($oButton) but also an options menu ($oMenu) on the side</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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<table border="1" class="docutils">
|
||||
</section>
|
||||
<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 width="24%" />
|
||||
<col width="35%" />
|
||||
<col width="30%" />
|
||||
<col width="5%" />
|
||||
<col width="5%" />
|
||||
<col style="width: 29%" />
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 61%" />
|
||||
</colgroup>
|
||||
<tbody valign="top">
|
||||
<tr class="row-odd"><td>oButton</td>
|
||||
<td>Button</td>
|
||||
<td>mandatory</td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p>AddButton</p></td>
|
||||
<td><p>Button</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>oMenu</td>
|
||||
<td>PopoverMenu</td>
|
||||
<td>mandatory</td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>AddButtons</p></td>
|
||||
<td><p>array</p></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 border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="29%" />
|
||||
<col width="10%" />
|
||||
<col width="61%" />
|
||||
</colgroup>
|
||||
<tbody valign="top">
|
||||
<tr class="row-odd"><td>AddButton</td>
|
||||
<td>Button</td>
|
||||
<td> </td>
|
||||
<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>AddButtons</td>
|
||||
<td>array</td>
|
||||
<td> </td>
|
||||
<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>AddCSSClass</td>
|
||||
<td>string</td>
|
||||
<td>CSS class to add to the generated html block</td>
|
||||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>AddCSSClasses</td>
|
||||
<td>array</td>
|
||||
<td>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></td>
|
||||
<tr class="row-even"><td><p>AddExtraBlock</p></td>
|
||||
<td><p>iUIBlock</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>AddCssFileRelPath</td>
|
||||
<td>string</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>AddHtml</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>AddExtraBlock</td>
|
||||
<td>iUIBlock</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>AddHtml</td>
|
||||
<td>string</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>AddJsFileRelPath</td>
|
||||
<td>string</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
|
||||
<td>array</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>Buttons</p></td>
|
||||
<td><p>array</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
|
||||
<td>array</td>
|
||||
<td> </td>
|
||||
<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>Buttons</td>
|
||||
<td>array</td>
|
||||
<td> </td>
|
||||
<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>CSSClasses</td>
|
||||
<td>array</td>
|
||||
<td>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>DataAttributes</td>
|
||||
<td>array</td>
|
||||
<td>Array of data attributes in the format [‘name’ => ‘value’]</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>IsHidden</td>
|
||||
<td>bool</td>
|
||||
<td>Indicates if the block is hidden by default</td>
|
||||
<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>
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user