diff options
author | Robert Jaros <rjaros@finn.pl> | 2018-02-09 13:40:35 +0100 |
---|---|---|
committer | Robert Jaros <rjaros@finn.pl> | 2018-02-09 13:40:35 +0100 |
commit | d8cd67062b8de6e8398dc6dfd00d201200c82414 (patch) | |
tree | 601082ec1eec73bc7a7d6ce8b51352e5345ffe81 /docs/api/pl.treksoft.kvision.utils/index.html | |
parent | 955304789ea83aceacbdf4c8a9eb742f6c2518f6 (diff) | |
download | kvision-d8cd67062b8de6e8398dc6dfd00d201200c82414.tar.gz kvision-d8cd67062b8de6e8398dc6dfd00d201200c82414.tar.bz2 kvision-d8cd67062b8de6e8398dc6dfd00d201200c82414.zip |
API doc and readme
Diffstat (limited to 'docs/api/pl.treksoft.kvision.utils/index.html')
-rw-r--r-- | docs/api/pl.treksoft.kvision.utils/index.html | 160 |
1 files changed, 160 insertions, 0 deletions
diff --git a/docs/api/pl.treksoft.kvision.utils/index.html b/docs/api/pl.treksoft.kvision.utils/index.html new file mode 100644 index 00000000..774a317d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.utils/index.html @@ -0,0 +1,160 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>pl.treksoft.kvision.utils - kvision</title> +<link rel="stylesheet" href="../../style.css"> +</HEAD> +<BODY> +<a href="../index.html">kvision</a> / <a href="./index.html">pl.treksoft.kvision.utils</a><br/> +<br/> +<h2>Package pl.treksoft.kvision.utils</h2> +<p>Interfaces and helper functions for Snabbdom virtual dom implementation and a few useful extension functions.</p> +<h3>Types</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-kv-event/index.html">KvEvent</a></p> +</td> +<td> +<code><span class="keyword">class </span><span class="identifier">KvEvent</span> <span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-custom-event/index.html"><span class="identifier">CustomEvent</span></a></code> +<p>Helper class for defining custom events.</p> +</td> +</tr> +<tr> +<td> +<p><a href="-object/index.html">Object</a></p> +</td> +<td> +<code><span class="keyword">external</span> <span class="keyword">class </span><span class="identifier">Object</span></code> +<p>JavaScript Object type</p> +</td> +</tr> +</tbody> +</table> +<h3>Extensions for External Classes</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="kotlin.-int/index.html">kotlin.Int</a></p> +</td> +<td> +</td> +</tr> +<tr> +<td> +<p><a href="kotlin.-pair/index.html">kotlin.Pair</a></p> +</td> +<td> +</td> +</tr> +<tr> +<td> +<p><a href="kotlin.-string/index.html">kotlin.String</a></p> +</td> +<td> +</td> +</tr> +<tr> +<td> +<p><a href="kotlin.js.-date/index.html">kotlin.js.Date</a></p> +</td> +<td> +</td> +</tr> +</tbody> +</table> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-e-n-t-e-r_-k-e-y.html">ENTER_KEY</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">ENTER_KEY</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code> +<p>Keycode of the ENTER key.</p> +</td> +</tr> +<tr> +<td> +<p><a href="-e-s-c_-k-e-y.html">ESC_KEY</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">ESC_KEY</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code> +<p>Keycode of the ESC key.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="auto.html">auto</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">auto</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../pl.treksoft.kvision.core/-css-size.html"><span class="identifier">CssSize</span></a></code> +<p>Helper function to describe CSS auto value.</p> +</td> +</tr> +<tr> +<td> +<p><a href="obj.html">obj</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">obj</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.utils$obj(kotlin.Function1((kotlin.Any, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <span class="keyword">dynamic</span><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="keyword">dynamic</span></code> +<p>Helper function for creating JavaScript objects.</p> +</td> +</tr> +<tr> +<td> +<p><a href="sn-attrs.html">snAttrs</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">snAttrs</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.utils$snAttrs(kotlin.collections.List((kotlin.Pair((kotlin.String, )))))/pairs">pairs</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-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Attrs</span></code> +<p>Helper function for creating attributes parameters for Snabbdom.</p> +</td> +</tr> +<tr> +<td> +<p><a href="sn-classes.html">snClasses</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">snClasses</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.utils$snClasses(kotlin.collections.List((kotlin.Pair((kotlin.String, kotlin.Boolean)))))/pairs">pairs</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><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Classes</span></code> +<p>Helper function for creating classes parameters for Snabbdom.</p> +</td> +</tr> +<tr> +<td> +<p><a href="sn-opt.html">snOpt</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">snOpt</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.utils$snOpt(kotlin.Function1((com.github.snabbdom.VNodeData, kotlin.Unit)))/block">block</span><span class="symbol">:</span> <span class="identifier">VNodeData</span><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="identifier">VNodeData</span></code> +<p>Helper function for creating object parameters for Snabbdom.</p> +</td> +</tr> +<tr> +<td> +<p><a href="sn-props.html">snProps</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">snProps</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.utils$snProps(kotlin.collections.List((kotlin.Pair((kotlin.String, )))))/pairs">pairs</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-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Props</span></code> +<p>Helper function for creating properties parameters for Snabbdom.</p> +</td> +</tr> +<tr> +<td> +<p><a href="sn-style.html">snStyle</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">snStyle</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.utils$snStyle(kotlin.collections.List((kotlin.Pair((kotlin.String, )))))/pairs">pairs</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-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">VNodeStyle</span></code> +<p>Helper function for creating style parameters for Snabbdom.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> |