diff options
| author | Robert Jaros <rjaros@finn.pl> | 2018-04-02 01:35:47 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2018-04-02 01:35:47 +0200 |
| commit | 806edfceeefe7fda47924f97237974e99fe28a02 (patch) | |
| tree | ab1f0cbd26fabd147c2343761c1577e05da373af /api/pl.treksoft.kvision.navbar/-nav | |
| parent | fe344a5450759e8eb8ffbb9c7d7f92a9ee5f4ee0 (diff) | |
| download | kvision-806edfceeefe7fda47924f97237974e99fe28a02.tar.gz kvision-806edfceeefe7fda47924f97237974e99fe28a02.tar.bz2 kvision-806edfceeefe7fda47924f97237974e99fe28a02.zip | |
API documentantion update
Diffstat (limited to 'api/pl.treksoft.kvision.navbar/-nav')
| -rw-r--r-- | api/pl.treksoft.kvision.navbar/-nav/-init-.html | 23 | ||||
| -rw-r--r-- | api/pl.treksoft.kvision.navbar/-nav/get-sn-class.html | 18 | ||||
| -rw-r--r-- | api/pl.treksoft.kvision.navbar/-nav/index.html | 132 | ||||
| -rw-r--r-- | api/pl.treksoft.kvision.navbar/-nav/nav.html | 16 | ||||
| -rw-r--r-- | api/pl.treksoft.kvision.navbar/-nav/right-align.html | 21 |
5 files changed, 210 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision.navbar/-nav/-init-.html b/api/pl.treksoft.kvision.navbar/-nav/-init-.html new file mode 100644 index 00000000..8a1e9a8e --- /dev/null +++ b/api/pl.treksoft.kvision.navbar/-nav/-init-.html @@ -0,0 +1,23 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Nav.<init> - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.navbar</a> / <a href="index.html">Nav</a> / <a href="./-init-.html"><init></a><br/> +<br/> +<h1><init></h1> +<a name="pl.treksoft.kvision.navbar.Nav$<init>(kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))"></a> +<code><span class="identifier">Nav</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.navbar.Nav$<init>(kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))/rightAlign">rightAlign</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.navbar.Nav$<init>(kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))/classes">classes</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html"><span class="identifier">Set</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">></span> <span class="symbol">=</span> setOf()<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.navbar.Nav$<init>(kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="index.html"><span class="identifier">Nav</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a> <span class="symbol">=</span> null<span class="symbol">)</span></code> +<h3>Parameters</h3> +<p><a name="rightAlign"></a> +<code>rightAlign</code> - determines if the nav is aligned to the right</p> +<p><a name="classes"></a> +<code>classes</code> - a set of CSS class names</p> +<p><a name="init"></a> +<code>init</code> - an initializer extension function</p> +<p><strong>Constructor</strong><br/> +</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.navbar/-nav/get-sn-class.html b/api/pl.treksoft.kvision.navbar/-nav/get-sn-class.html new file mode 100644 index 00000000..015896a5 --- /dev/null +++ b/api/pl.treksoft.kvision.navbar/-nav/get-sn-class.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Nav.getSnClass - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.navbar</a> / <a href="index.html">Nav</a> / <a href="./get-sn-class.html">getSnClass</a><br/> +<br/> +<h1>getSnClass</h1> +<a name="pl.treksoft.kvision.navbar.Nav$getSnClass()"></a> +<code><span class="keyword">protected</span> <span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnClass</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-string-bool-pair.html"><span class="identifier">StringBoolPair</span></a><span class="symbol">></span></code> +<p>Overrides <a href="../../pl.treksoft.kvision.html/-tag/get-sn-class.html">Tag.getSnClass</a></p> +<p>Returns list of CSS class names for current widget in the form of a List.</p> +<p><strong>Return</strong><br/> +list of CSS class names</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.navbar/-nav/index.html b/api/pl.treksoft.kvision.navbar/-nav/index.html new file mode 100644 index 00000000..54629bac --- /dev/null +++ b/api/pl.treksoft.kvision.navbar/-nav/index.html @@ -0,0 +1,132 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Nav - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.navbar</a> / <a href="./index.html">Nav</a><br/> +<br/> +<h1>Nav</h1> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Nav</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.html/-tag/index.html"><span class="identifier">Tag</span></a></code> +<p>The Bootstrap Nav container.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">Nav</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.navbar.Nav$<init>(kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))/rightAlign">rightAlign</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.navbar.Nav$<init>(kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))/classes">classes</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html"><span class="identifier">Set</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">></span> <span class="symbol">=</span> setOf()<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.navbar.Nav$<init>(kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">Nav</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a> <span class="symbol">=</span> null<span class="symbol">)</span></code></td> +</tr> +</tbody> +</table> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="right-align.html">rightAlign</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">rightAlign</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code> +<p>Determines if the nav is aligned to the right.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.html/-tag/align.html">align</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">align</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.html/-align/index.html"><span class="identifier">Align</span></a><span class="symbol">?</span></code> +<p>Text align.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.html/-tag/content.html">content</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">content</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code> +<p>Text content of the tag.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.html/-tag/rich.html">rich</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">rich</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code> +<p>Determines if <a href="../../pl.treksoft.kvision.html/-tag/content.html">content</a> can contain HTML code.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.html/-tag/template.html">template</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">template</span><span class="symbol">: </span><span class="symbol">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>Handlebars template.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.html/-tag/type.html">type</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">type</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.html/-t-a-g/index.html"><span class="identifier">TAG</span></a></code> +<p>Tag type.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="get-sn-class.html">getSnClass</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnClass</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-string-bool-pair.html"><span class="identifier">StringBoolPair</span></a><span class="symbol">></span></code> +<p>Returns list of CSS class names for current widget in the form of a List.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.html/-tag/render.html">render</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">render</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">VNode</span></code> +<p>Renders current component as a Snabbdom vnode.</p> +</td> +</tr> +</tbody> +</table> +<h3>Companion Object Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="nav.html">nav</a></p> +</td> +<td> +<code><span class="keyword">fun </span><a href="../-navbar/index.html"><span class="identifier">Navbar</span></a><span class="symbol">.</span><span class="identifier">nav</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.navbar.Nav.Companion$nav(pl.treksoft.kvision.navbar.Navbar, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))/rightAlign">rightAlign</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.navbar.Nav.Companion$nav(pl.treksoft.kvision.navbar.Navbar, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))/classes">classes</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html"><span class="identifier">Set</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">></span> <span class="symbol">=</span> setOf()<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.navbar.Nav.Companion$nav(pl.treksoft.kvision.navbar.Navbar, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">Nav</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">Nav</span></a></code> +<p>DSL builder extension function.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.navbar/-nav/nav.html b/api/pl.treksoft.kvision.navbar/-nav/nav.html new file mode 100644 index 00000000..98f27419 --- /dev/null +++ b/api/pl.treksoft.kvision.navbar/-nav/nav.html @@ -0,0 +1,16 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Nav.nav - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.navbar</a> / <a href="index.html">Nav</a> / <a href="./nav.html">nav</a><br/> +<br/> +<h1>nav</h1> +<a name="pl.treksoft.kvision.navbar.Nav.Companion$nav(pl.treksoft.kvision.navbar.Navbar, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))"></a> +<code><span class="keyword">fun </span><a href="../-navbar/index.html"><span class="identifier">Navbar</span></a><span class="symbol">.</span><span class="identifier">nav</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.navbar.Nav.Companion$nav(pl.treksoft.kvision.navbar.Navbar, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))/rightAlign">rightAlign</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.navbar.Nav.Companion$nav(pl.treksoft.kvision.navbar.Navbar, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))/classes">classes</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html"><span class="identifier">Set</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">></span> <span class="symbol">=</span> setOf()<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.navbar.Nav.Companion$nav(pl.treksoft.kvision.navbar.Navbar, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.navbar.Nav, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="index.html"><span class="identifier">Nav</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="index.html"><span class="identifier">Nav</span></a></code> +<p>DSL builder extension function.</p> +<p>It takes the same parameters as the constructor of the built component.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.navbar/-nav/right-align.html b/api/pl.treksoft.kvision.navbar/-nav/right-align.html new file mode 100644 index 00000000..6ddf4b35 --- /dev/null +++ b/api/pl.treksoft.kvision.navbar/-nav/right-align.html @@ -0,0 +1,21 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Nav.rightAlign - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.navbar</a> / <a href="index.html">Nav</a> / <a href="./right-align.html">rightAlign</a><br/> +<br/> +<h1>rightAlign</h1> +<a name="pl.treksoft.kvision.navbar.Nav$rightAlign"></a> +<code><span class="keyword">var </span><span class="identifier">rightAlign</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code> +<p>Determines if the nav is aligned to the right.</p> +<p><strong>Getter</strong><br/> +<p>Determines if the nav is aligned to the right.</p> +</p> +<p><strong>Setter</strong><br/> +<p>Determines if the nav is aligned to the right.</p> +</p> +</BODY> +</HTML> |