diff options
| author | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
| commit | fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb (patch) | |
| tree | 911c8e9b208b9ba77f00531668d1d99b40fcb8e3 /api1/pl.treksoft.kvision.html/-icon | |
| parent | 4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17 (diff) | |
| download | kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.gz kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.bz2 kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.zip | |
API documentation for KVision 2.0.0
Diffstat (limited to 'api1/pl.treksoft.kvision.html/-icon')
| -rw-r--r-- | api1/pl.treksoft.kvision.html/-icon/-init-.html | 19 | ||||
| -rw-r--r-- | api1/pl.treksoft.kvision.html/-icon/get-sn-class.html | 18 | ||||
| -rw-r--r-- | api1/pl.treksoft.kvision.html/-icon/icon.html | 25 | ||||
| -rw-r--r-- | api1/pl.treksoft.kvision.html/-icon/index.html | 172 |
4 files changed, 234 insertions, 0 deletions
diff --git a/api1/pl.treksoft.kvision.html/-icon/-init-.html b/api1/pl.treksoft.kvision.html/-icon/-init-.html new file mode 100644 index 00000000..08671b45 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-icon/-init-.html @@ -0,0 +1,19 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Icon.<init> - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.html</a> / <a href="index.html">Icon</a> / <a href="./-init-.html"><init></a><br/> +<br/> +<h1><init></h1> +<a name="pl.treksoft.kvision.html.Icon$<init>(kotlin.String)"></a> +<code><span class="identifier">Icon</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html.Icon$<init>(kotlin.String)/icon">icon</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> +<h3>Parameters</h3> +<p><a name="icon"></a> +<code>icon</code> - icon name</p> +<p><strong>Constructor</strong><br/> +</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.html/-icon/get-sn-class.html b/api1/pl.treksoft.kvision.html/-icon/get-sn-class.html new file mode 100644 index 00000000..ae52c838 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-icon/get-sn-class.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Icon.getSnClass - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.html</a> / <a href="index.html">Icon</a> / <a href="./get-sn-class.html">getSnClass</a><br/> +<br/> +<h1>getSnClass</h1> +<a name="pl.treksoft.kvision.html.Icon$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="../-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/api1/pl.treksoft.kvision.html/-icon/icon.html b/api1/pl.treksoft.kvision.html/-icon/icon.html new file mode 100644 index 00000000..3ed999be --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-icon/icon.html @@ -0,0 +1,25 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Icon.icon - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.html</a> / <a href="index.html">Icon</a> / <a href="./icon.html">icon</a><br/> +<br/> +<h1>icon</h1> +<a name="pl.treksoft.kvision.html.Icon$icon"></a> +<code><span class="keyword">var </span><span class="identifier">icon</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>Icon type.</p> +<p><strong>Getter</strong><br/> +<p>Icon type.</p> +</p> +<p><strong>Setter</strong><br/> +<p>Icon type.</p> +</p> +<a name="pl.treksoft.kvision.html.Icon.Companion$icon(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Function1((pl.treksoft.kvision.html.Icon, kotlin.Unit)))"></a> +<code><span class="keyword">fun </span><a href="../../pl.treksoft.kvision.core/-container/index.html"><span class="identifier">Container</span></a><span class="symbol">.</span><span class="identifier">icon</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html.Icon.Companion$icon(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Function1((pl.treksoft.kvision.html.Icon, kotlin.Unit)))/icon">icon</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><span class="identifier" id="pl.treksoft.kvision.html.Icon.Companion$icon(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Function1((pl.treksoft.kvision.html.Icon, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <span class="symbol">(</span><a href="index.html"><span class="identifier">Icon</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><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="index.html"><span class="identifier">Icon</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/api1/pl.treksoft.kvision.html/-icon/index.html b/api1/pl.treksoft.kvision.html/-icon/index.html new file mode 100644 index 00000000..4f9b2ad9 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-icon/index.html @@ -0,0 +1,172 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Icon - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.html</a> / <a href="./index.html">Icon</a><br/> +<br/> +<h1>Icon</h1> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Icon</span> <span class="symbol">:</span> <a href="../-tag/index.html"><span class="identifier">Tag</span></a></code> +<p>Icon component with support for FontAwesome and Bootstrap glyphicons.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">Icon</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html.Icon$<init>(kotlin.String)/icon">icon</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></td> +</tr> +</tbody> +</table> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="icon.html">icon</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">icon</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>Icon type.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../-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="../-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="../-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="../-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="../-tag/content.html">content</a> can contain HTML code.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-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><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><span class="symbol">)</span><span class="symbol">?</span></code> +<p>Handlebars template.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-tag/templates.html">templates</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">templates</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html"><span class="identifier">Map</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><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><span class="symbol">></span></code> +<p>Handlebars templates for i18n.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-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="../-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="../-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> +<tr> +<td> +<p><a href="../-tag/unary-plus.html">unaryPlus</a></p> +</td> +<td> +<code><span class="keyword">operator</span> <span class="keyword">fun </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="identifier">unaryPlus</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></code></td> +</tr> +</tbody> +</table> +<h3>Companion Object Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="icon.html">icon</a></p> +</td> +<td> +<code><span class="keyword">fun </span><a href="../../pl.treksoft.kvision.core/-container/index.html"><span class="identifier">Container</span></a><span class="symbol">.</span><span class="identifier">icon</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html.Icon.Companion$icon(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Function1((pl.treksoft.kvision.html.Icon, kotlin.Unit)))/icon">icon</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><span class="identifier" id="pl.treksoft.kvision.html.Icon.Companion$icon(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Function1((pl.treksoft.kvision.html.Icon, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <span class="symbol">(</span><a href="./index.html"><span class="identifier">Icon</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><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">Icon</span></a></code> +<p>DSL builder extension function.</p> +</td> +</tr> +</tbody> +</table> +<h3>Extension Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html">createInstance</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</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="identifier">createInstance</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.utils$createInstance(kotlin.Any, kotlin.Array((kotlin.Any)))/args">args</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html#T"><span class="identifier">T</span></a></code> +<p>Helper function for creating JavaScript objects from dynamic constructors.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../set-data.html">setData</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">K</span><span class="symbol">></span> <a href="../-template/index.html"><span class="identifier">Template</span></a><span class="symbol">.</span><span class="identifier">setData</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html$setData(pl.treksoft.kvision.html.Template, pl.treksoft.kvision.html.setData.K, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.html.setData.K)))/obj">obj</span><span class="symbol">:</span> <a href="../set-data.html#K"><span class="identifier">K</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.html$setData(pl.treksoft.kvision.html.Template, pl.treksoft.kvision.html.setData.K, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.html.setData.K)))/serializer">serializer</span><span class="symbol">:</span> <span class="identifier">SerializationStrategy</span><span class="symbol"><</span><a href="../set-data.html#K"><span class="identifier">K</span></a><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></code><br/> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">K</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> <a href="../-template/index.html"><span class="identifier">Template</span></a><span class="symbol">.</span><span class="identifier">setData</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html$setData(pl.treksoft.kvision.html.Template, pl.treksoft.kvision.html.setData.K)/obj">obj</span><span class="symbol">:</span> <a href="../set-data.html#K"><span class="identifier">K</span></a><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></code> +<p>Extension function to set serializable object as a template data.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> |