diff options
Diffstat (limited to 'api/pl.treksoft.kvision.redux')
14 files changed, 777 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision.redux/-dispatch.html b/api/pl.treksoft.kvision.redux/-dispatch.html new file mode 100644 index 00000000..b795c4b0 --- /dev/null +++ b/api/pl.treksoft.kvision.redux/-dispatch.html @@ -0,0 +1,13 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Dispatch - kvision</title> +<link rel="stylesheet" href="../../style.css"> +</HEAD> +<BODY> +<a href="../index.html">kvision</a> / <a href="index.html">pl.treksoft.kvision.redux</a> / <a href="./-dispatch.html">Dispatch</a><br/> +<br/> +<h1>Dispatch</h1> +<code><span class="keyword">typealias </span><span class="identifier">Dispatch</span><span class="symbol"><</span><span class="identifier">A</span><span class="symbol">></span> <span class="symbol">=</span> <span class="symbol">(</span><a href="-dispatch.html#A"><span class="identifier">A</span></a><span class="symbol">)</span> <span class="symbol">-></span> <span class="identifier"><ERROR CLASS></span></code> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.redux/-get-state.html b/api/pl.treksoft.kvision.redux/-get-state.html new file mode 100644 index 00000000..b9d37218 --- /dev/null +++ b/api/pl.treksoft.kvision.redux/-get-state.html @@ -0,0 +1,13 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>GetState - kvision</title> +<link rel="stylesheet" href="../../style.css"> +</HEAD> +<BODY> +<a href="../index.html">kvision</a> / <a href="index.html">pl.treksoft.kvision.redux</a> / <a href="./-get-state.html">GetState</a><br/> +<br/> +<h1>GetState</h1> +<code><span class="keyword">typealias </span><span class="identifier">GetState</span><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span> <span class="symbol">=</span> <span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="-get-state.html#S"><span class="identifier">S</span></a></code> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.redux/-redux-store/-init-.html b/api/pl.treksoft.kvision.redux/-redux-store/-init-.html new file mode 100644 index 00000000..0c7d04f5 --- /dev/null +++ b/api/pl.treksoft.kvision.redux/-redux-store/-init-.html @@ -0,0 +1,30 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>ReduxStore.<init> - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.redux</a> / <a href="index.html">ReduxStore</a> / <a href="./-init-.html"><init></a><br/> +<br/> +<h1><init></h1> +<a name="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))"></a> +<code><span class="identifier">ReduxStore</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/reducer">reducer</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="index.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/initialState">initialState</span><span class="symbol">:</span> <a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/stateSerializer">stateSerializer</span><span class="symbol">:</span> <span class="identifier">KSerializer</span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">></span><span class="symbol">, </span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/middlewares">middlewares</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span></code> +<p>Creates a Redux store with given reducer function and initial state.</p> +<h3>Parameters</h3> +<p><a name="S"></a> +<code>S</code> - redux state type (@Serializable)</p> +<p><a name="A"></a> +<code>A</code> - redux action type</p> +<p><a name="reducer"></a> +<code>reducer</code> - a reducer function</p> +<p><a name="state"></a> +<code>state</code> - an initial state</p> +<p><a name="stateSerializer"></a> +<code>stateSerializer</code> - a serializer for the state type</p> +<p><a name="middlewares"></a> +<code>middlewares</code> - a list of optional Redux JS middlewares</p> +<p><strong>Constructor</strong><br/> +Creates a Redux store with given reducer function and initial state.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.redux/-redux-store/dispatch.html b/api/pl.treksoft.kvision.redux/-redux-store/dispatch.html new file mode 100644 index 00000000..864840fe --- /dev/null +++ b/api/pl.treksoft.kvision.redux/-redux-store/dispatch.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>ReduxStore.dispatch - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.redux</a> / <a href="index.html">ReduxStore</a> / <a href="./dispatch.html">dispatch</a><br/> +<br/> +<h1>dispatch</h1> +<a name="pl.treksoft.kvision.redux.ReduxStore$dispatch(pl.treksoft.kvision.redux.ReduxStore.A)"></a> +<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(pl.treksoft.kvision.redux.ReduxStore.A)/action">action</span><span class="symbol">:</span> <a href="index.html#A"><span class="identifier">A</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code> +<p>Dispatches a synchronous action object.</p> +<a name="pl.treksoft.kvision.redux.ReduxStore$dispatch(kotlin.Function2((kotlin.Function1((pl.treksoft.kvision.redux.ReduxStore.A, )), kotlin.Function0((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Unit)))"></a> +<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(kotlin.Function2((kotlin.Function1((pl.treksoft.kvision.redux.ReduxStore.A, )), kotlin.Function0((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Unit)))/action">action</span><span class="symbol">:</span> <span class="symbol">(</span><a href="../-dispatch.html"><span class="identifier">Dispatch</span></a><span class="symbol"><</span><a href="index.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">,</span> <a href="../-get-state.html"><span class="identifier">GetState</span></a><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</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><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code> +<p>Dispatches an asynchronous action function.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.redux/-redux-store/get-state.html b/api/pl.treksoft.kvision.redux/-redux-store/get-state.html new file mode 100644 index 00000000..bf7d9205 --- /dev/null +++ b/api/pl.treksoft.kvision.redux/-redux-store/get-state.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>ReduxStore.getState - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.redux</a> / <a href="index.html">ReduxStore</a> / <a href="./get-state.html">getState</a><br/> +<br/> +<h1>getState</h1> +<a name="pl.treksoft.kvision.redux.ReduxStore$getState()"></a> +<code><span class="keyword">fun </span><span class="identifier">getState</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="index.html#S"><span class="identifier">S</span></a></code> +<p>Returns the current state.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.redux/-redux-store/index.html b/api/pl.treksoft.kvision.redux/-redux-store/index.html new file mode 100644 index 00000000..0c8f9a80 --- /dev/null +++ b/api/pl.treksoft.kvision.redux/-redux-store/index.html @@ -0,0 +1,91 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>ReduxStore - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.redux</a> / <a href="./index.html">ReduxStore</a><br/> +<br/> +<h1>ReduxStore</h1> +<code><span class="keyword">class </span><span class="identifier">ReduxStore</span><span class="symbol"><</span><span class="identifier">S</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="identifier">A</span><span class="symbol">></span></code> +<p>A class implementing redux pattern backed by the original Redux JS library. +It requires @Serializable state.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">ReduxStore</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/reducer">reducer</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="index.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/initialState">initialState</span><span class="symbol">:</span> <a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/stateSerializer">stateSerializer</span><span class="symbol">:</span> <span class="identifier">KSerializer</span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">></span><span class="symbol">, </span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/middlewares">middlewares</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span></code> +<p>Creates a Redux store with given reducer function and initial state.</p> +</td> +</tr> +</tbody> +</table> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="state-serializer.html">stateSerializer</a></p> +</td> +<td> +<code><span class="keyword">val </span><span class="identifier">stateSerializer</span><span class="symbol">: </span><span class="identifier">KSerializer</span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">></span></code> +<p>a serializer for the state type</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="dispatch.html">dispatch</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(pl.treksoft.kvision.redux.ReduxStore.A)/action">action</span><span class="symbol">:</span> <a href="index.html#A"><span class="identifier">A</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code> +<p>Dispatches a synchronous action object.</p> +<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(kotlin.Function2((kotlin.Function1((pl.treksoft.kvision.redux.ReduxStore.A, )), kotlin.Function0((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Unit)))/action">action</span><span class="symbol">:</span> <span class="symbol">(</span><a href="../-dispatch.html"><span class="identifier">Dispatch</span></a><span class="symbol"><</span><a href="index.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">,</span> <a href="../-get-state.html"><span class="identifier">GetState</span></a><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</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><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code> +<p>Dispatches an asynchronous action function.</p> +</td> +</tr> +<tr> +<td> +<p><a href="get-state.html">getState</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">getState</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="index.html#S"><span class="identifier">S</span></a></code> +<p>Returns the current state.</p> +</td> +</tr> +<tr> +<td> +<p><a href="subscribe.html">subscribe</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">subscribe</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$subscribe(kotlin.Function1((pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Unit)))/listener">listener</span><span class="symbol">:</span> <span class="symbol">(</span><a href="index.html#S"><span class="identifier">S</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><span class="symbol">)</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></code> +<p>Subscribes a client for the change state notifications.</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> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.redux/-redux-store/state-serializer.html b/api/pl.treksoft.kvision.redux/-redux-store/state-serializer.html new file mode 100644 index 00000000..ea96ec0c --- /dev/null +++ b/api/pl.treksoft.kvision.redux/-redux-store/state-serializer.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>ReduxStore.stateSerializer - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.redux</a> / <a href="index.html">ReduxStore</a> / <a href="./state-serializer.html">stateSerializer</a><br/> +<br/> +<h1>stateSerializer</h1> +<a name="pl.treksoft.kvision.redux.ReduxStore$stateSerializer"></a> +<code><span class="keyword">val </span><span class="identifier">stateSerializer</span><span class="symbol">: </span><span class="identifier">KSerializer</span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">></span></code> +<p>a serializer for the state type</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.redux/-redux-store/subscribe.html b/api/pl.treksoft.kvision.redux/-redux-store/subscribe.html new file mode 100644 index 00000000..55376e06 --- /dev/null +++ b/api/pl.treksoft.kvision.redux/-redux-store/subscribe.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>ReduxStore.subscribe - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.redux</a> / <a href="index.html">ReduxStore</a> / <a href="./subscribe.html">subscribe</a><br/> +<br/> +<h1>subscribe</h1> +<a name="pl.treksoft.kvision.redux.ReduxStore$subscribe(kotlin.Function1((pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Unit)))"></a> +<code><span class="keyword">fun </span><span class="identifier">subscribe</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$subscribe(kotlin.Function1((pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Unit)))/listener">listener</span><span class="symbol">:</span> <span class="symbol">(</span><a href="index.html#S"><span class="identifier">S</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><span class="symbol">)</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></code> +<p>Subscribes a client for the change state notifications.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.redux/-state-binding/-init-.html b/api/pl.treksoft.kvision.redux/-state-binding/-init-.html new file mode 100644 index 00000000..da648ab0 --- /dev/null +++ b/api/pl.treksoft.kvision.redux/-state-binding/-init-.html @@ -0,0 +1,30 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StateBinding.<init> - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.redux</a> / <a href="index.html">StateBinding</a> / <a href="./-init-.html"><init></a><br/> +<br/> +<h1><init></h1> +<a name="pl.treksoft.kvision.redux.StateBinding$<init>(pl.treksoft.kvision.redux.ReduxStore((pl.treksoft.kvision.redux.StateBinding.S, pl.treksoft.kvision.redux.StateBinding.A)), pl.treksoft.kvision.redux.StateBinding.CONT, kotlin.Function2((pl.treksoft.kvision.redux.StateBinding.CONT, pl.treksoft.kvision.redux.StateBinding.S, kotlin.Unit)))"></a> +<code><span class="identifier">StateBinding</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.StateBinding$<init>(pl.treksoft.kvision.redux.ReduxStore((pl.treksoft.kvision.redux.StateBinding.S, pl.treksoft.kvision.redux.StateBinding.A)), pl.treksoft.kvision.redux.StateBinding.CONT, kotlin.Function2((pl.treksoft.kvision.redux.StateBinding.CONT, pl.treksoft.kvision.redux.StateBinding.S, kotlin.Unit)))/store">store</span><span class="symbol">:</span> <a href="../-redux-store/index.html"><span class="identifier">ReduxStore</span></a><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="index.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.StateBinding$<init>(pl.treksoft.kvision.redux.ReduxStore((pl.treksoft.kvision.redux.StateBinding.S, pl.treksoft.kvision.redux.StateBinding.A)), pl.treksoft.kvision.redux.StateBinding.CONT, kotlin.Function2((pl.treksoft.kvision.redux.StateBinding.CONT, pl.treksoft.kvision.redux.StateBinding.S, kotlin.Unit)))/container">container</span><span class="symbol">:</span> <a href="index.html#CONT"><span class="identifier">CONT</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.StateBinding$<init>(pl.treksoft.kvision.redux.ReduxStore((pl.treksoft.kvision.redux.StateBinding.S, pl.treksoft.kvision.redux.StateBinding.A)), pl.treksoft.kvision.redux.StateBinding.CONT, kotlin.Function2((pl.treksoft.kvision.redux.StateBinding.CONT, pl.treksoft.kvision.redux.StateBinding.S, kotlin.Unit)))/factory">factory</span><span class="symbol">:</span> <a href="index.html#CONT"><span class="identifier">CONT</span></a><span class="symbol">.</span><span class="symbol">(</span><a href="index.html#S"><span class="identifier">S</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><span class="symbol">)</span></code> +<p>Creates StateBinding which binds the redux store with the given container.</p> +<h3>Parameters</h3> +<p><a name="S"></a> +<code>S</code> - redux state type</p> +<p><a name="A"></a> +<code>A</code> - redux action type</p> +<p><a name="CONT"></a> +<code>CONT</code> - container type</p> +<p><a name="store"></a> +<code>store</code> - a redux store</p> +<p><a name="container"></a> +<code>container</code> - a container</p> +<p><a name="factory"></a> +<code>factory</code> - a function which re-creates the view based on the given state</p> +<p><strong>Constructor</strong><br/> +Creates StateBinding which binds the redux store with the given container.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.redux/-state-binding/index.html b/api/pl.treksoft.kvision.redux/-state-binding/index.html new file mode 100644 index 00000000..625c5c0b --- /dev/null +++ b/api/pl.treksoft.kvision.redux/-state-binding/index.html @@ -0,0 +1,415 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StateBinding - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.redux</a> / <a href="./index.html">StateBinding</a><br/> +<br/> +<h1>StateBinding</h1> +<code><span class="keyword">class </span><span class="identifier">StateBinding</span><span class="symbol"><</span><span class="identifier">S</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="identifier">A</span><span class="symbol">, </span><span class="identifier">CONT</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-container/index.html"><span class="identifier">Container</span></a><span class="symbol">></span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>A class which binds the redux store with the given container.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">StateBinding</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.StateBinding$<init>(pl.treksoft.kvision.redux.ReduxStore((pl.treksoft.kvision.redux.StateBinding.S, pl.treksoft.kvision.redux.StateBinding.A)), pl.treksoft.kvision.redux.StateBinding.CONT, kotlin.Function2((pl.treksoft.kvision.redux.StateBinding.CONT, pl.treksoft.kvision.redux.StateBinding.S, kotlin.Unit)))/store">store</span><span class="symbol">:</span> <a href="../-redux-store/index.html"><span class="identifier">ReduxStore</span></a><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="index.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.StateBinding$<init>(pl.treksoft.kvision.redux.ReduxStore((pl.treksoft.kvision.redux.StateBinding.S, pl.treksoft.kvision.redux.StateBinding.A)), pl.treksoft.kvision.redux.StateBinding.CONT, kotlin.Function2((pl.treksoft.kvision.redux.StateBinding.CONT, pl.treksoft.kvision.redux.StateBinding.S, kotlin.Unit)))/container">container</span><span class="symbol">:</span> <a href="index.html#CONT"><span class="identifier">CONT</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.StateBinding$<init>(pl.treksoft.kvision.redux.ReduxStore((pl.treksoft.kvision.redux.StateBinding.S, pl.treksoft.kvision.redux.StateBinding.A)), pl.treksoft.kvision.redux.StateBinding.CONT, kotlin.Function2((pl.treksoft.kvision.redux.StateBinding.CONT, pl.treksoft.kvision.redux.StateBinding.S, kotlin.Unit)))/factory">factory</span><span class="symbol">:</span> <a href="index.html#CONT"><span class="identifier">CONT</span></a><span class="symbol">.</span><span class="symbol">(</span><a href="index.html#S"><span class="identifier">S</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><span class="symbol">)</span></code> +<p>Creates StateBinding which binds the redux store with the given container.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/draggable.html">draggable</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">draggable</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></code> +<p>Determines if the current widget is draggable.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/event-target.html">eventTarget</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">eventTarget</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a><span class="symbol">?</span></code></td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/id.html">id</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">id</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>An ID attribute of generated HTML element.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/last-language.html">lastLanguage</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">lastLanguage</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> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/parent.html">parent</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">parent</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-container/index.html"><span class="identifier">Container</span></a><span class="symbol">?</span></code> +<p>Parent of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/role.html">role</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">role</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>A role attribute of generated HTML element.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/surrounding-span.html">surroundingSpan</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">surroundingSpan</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></td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/title.html">title</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">title</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>A title attribute of generated HTML element.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/visible.html">visible</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">visible</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>Visibility state of the current component.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="update.html">update</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">update</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.StateBinding$update(pl.treksoft.kvision.redux.StateBinding.S)/state">state</span><span class="symbol">:</span> <a href="index.html#S"><span class="identifier">S</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>Updates view from the current state.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/add-css-class.html">addCssClass</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">addCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$addCssClass(kotlin.String)/css">css</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><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Adds given value to the set of CSS classes generated in html code of current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/add-surrounding-css-class.html">addSurroundingCssClass</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">addSurroundingCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$addSurroundingCssClass(kotlin.String)/css">css</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><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Adds given value to the set of CSS classes generated in html code of parent component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/after-create.html">afterCreate</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterCreate</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$afterCreate(com.github.snabbdom.VNode)/node">node</span><span class="symbol">:</span> <span class="identifier">VNode</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> +<p>Method called after creating Snabbdom vnode.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/after-destroy.html">afterDestroy</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterDestroy</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> +<p>Method called after destroying Snabbdom vnode.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/after-insert.html">afterInsert</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterInsert</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$afterInsert(com.github.snabbdom.VNode)/node">node</span><span class="symbol">:</span> <span class="identifier">VNode</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> +<p>Method called after inserting Snabbdom vnode into the DOM.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/after-postpatch.html">afterPostpatch</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterPostpatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$afterPostpatch(com.github.snabbdom.VNode)/node">node</span><span class="symbol">:</span> <span class="identifier">VNode</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> +<p>Method called after updating Snabbdom vnode.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/clear-drag-drop-data.html">clearDragDropData</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">clearDragDropData</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> +<p>Clears D&D data for the current widget. It also makes it not draggable.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/dispatch-event.html">dispatchEvent</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">dispatchEvent</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$dispatchEvent(kotlin.String, org.w3c.dom.CustomEventInit)/type">type</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.core.Widget$dispatchEvent(kotlin.String, org.w3c.dom.CustomEventInit)/eventInitDict">eventInitDict</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-custom-event-init/index.html"><span class="identifier">CustomEventInit</span></a><span class="symbol">)</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></code></td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/get-element.html">getElement</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getElement</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html"><span class="identifier">Node</span></a><span class="symbol">?</span></code> +<p>Returns DOM element bound to the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/get-element-j-query.html">getElementJQuery</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getElementJQuery</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">JQuery</span><span class="symbol">?</span></code> +<p>Returns JQuery element bound to the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/get-element-j-query-d.html">getElementJQueryD</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getElementJQueryD</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="keyword">dynamic</span></code> +<p>Returns JQuery element bound to the current component as a <em>dynamic</em> type.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/get-sn-attrs.html">getSnAttrs</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnAttrs</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-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">></span></code> +<p>Returns list of element attributes in the form of a List.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/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> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/get-sn-hooks.html">getSnHooks</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnHooks</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Hooks</span><span class="symbol">?</span></code> +<p>Returns list of hooks in the form of a Snabbdom <em>Hooks</em> object.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/get-sn-on.html">getSnOn</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnOn</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">On</span><span class="symbol">?</span></code> +<p>Returns list of event handlers in the form of a Snabbdom <em>On</em> object.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/hide.html">hide</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">hide</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Makes current widget invisible.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/remove-css-class.html">removeCssClass</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$removeCssClass(kotlin.String)/css">css</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><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Removes given value from the set of CSS classes generated in html code of current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/remove-event-listeners.html">removeEventListeners</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeEventListeners</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Removes all event listeners from current widget.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/remove-surrounding-css-class.html">removeSurroundingCssClass</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeSurroundingCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$removeSurroundingCssClass(kotlin.String)/css">css</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><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Removes given value from the set of CSS classes generated in html code of parent component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/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><br/> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">render</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$render(kotlin.String)/elementName">elementName</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><span class="identifier">VNode</span></code><br/> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">render</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$render(kotlin.String, kotlin.Array((kotlin.Any)))/elementName">elementName</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.core.Widget$render(kotlin.String, kotlin.Array((kotlin.Any)))/children">children</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html"><span class="identifier">Array</span></a><span class="symbol"><</span><span class="keyword">dynamic</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="../../pl.treksoft.kvision.core/-widget/set-context-menu.html">setContextMenu</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">setContextMenu</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setContextMenu(pl.treksoft.kvision.dropdown.ContextMenu)/contextMenu">contextMenu</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.dropdown/-context-menu/index.html"><span class="identifier">ContextMenu</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Sets context menu for the current widget.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/set-drag-drop-data.html">setDragDropData</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">setDragDropData</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setDragDropData(kotlin.String, kotlin.String)/format">format</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.core.Widget$setDragDropData(kotlin.String, kotlin.String)/data">data</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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Sets D&D data for the current widget. It also makes it draggable.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/set-drop-target.html">setDropTarget</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">setDropTarget</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setDropTarget(kotlin.String, kotlin.Function1((org.w3c.dom.DragEvent, kotlin.Unit)))/format">format</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.core.Widget$setDropTarget(kotlin.String, kotlin.Function1((org.w3c.dom.DragEvent, kotlin.Unit)))/callback">callback</span><span class="symbol">:</span> <span class="symbol">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-drag-event/index.html"><span class="identifier">DragEvent</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><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">open</span> <span class="keyword">fun </span><span class="identifier">setDropTarget</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setDropTarget(kotlin.collections.Set((kotlin.String)), kotlin.Function1((org.w3c.dom.DragEvent, kotlin.Unit)))/formats">formats</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> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setDropTarget(kotlin.collections.Set((kotlin.String)), kotlin.Function1((org.w3c.dom.DragEvent, kotlin.Unit)))/callback">callback</span><span class="symbol">:</span> <span class="symbol">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-drag-event/index.html"><span class="identifier">DragEvent</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><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>Sets the current widget as a D&D drop target.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/set-drop-target-data.html">setDropTargetData</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">setDropTargetData</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setDropTargetData(kotlin.String, kotlin.Function1((kotlin.String, kotlin.Unit)))/format">format</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.core.Widget$setDropTargetData(kotlin.String, kotlin.Function1((kotlin.String, kotlin.Unit)))/callback">callback</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> <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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Sets the current widget as a D&D drop target with helper callback accepting String data.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/set-event-listener.html">setEventListener</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a><span class="symbol">></span> <span class="identifier">setEventListener</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setEventListener(kotlin.Function1((pl.treksoft.kvision.utils.SnOn((pl.treksoft.kvision.core.Widget.setEventListener.T)), kotlin.Unit)))/block">block</span><span class="symbol">:</span> <span class="identifier">SnOn</span><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-widget/set-event-listener.html#T"><span class="identifier">T</span></a><span class="symbol">></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><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Sets an event listener for current widget, keeping the actual type of component.</p> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">setEventListener</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setEventListener(kotlin.Function1((pl.treksoft.kvision.utils.SnOn((pl.treksoft.kvision.core.Widget)), kotlin.Unit)))/block">block</span><span class="symbol">:</span> <span class="identifier">SnOn</span><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a><span class="symbol">></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><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Sets an event listener for current widget.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/show.html">show</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">show</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Makes current widget visible.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/single-render.html">singleRender</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">singleRender</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$singleRender(kotlin.Function0((pl.treksoft.kvision.core.Widget.singleRender.T)))/block">block</span><span class="symbol">:</span> <span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="../../pl.treksoft.kvision.core/-widget/single-render.html#T"><span class="identifier">T</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/single-render.html#T"><span class="identifier">T</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/toggle-visible.html">toggleVisible</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">toggleVisible</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Toggles visibility of current widget.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/translate.html">translate</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">translate</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$translate(kotlin.String)/text">text</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><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>Companion Object Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="state-binding.html">stateBinding</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">S</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="identifier">A</span><span class="symbol">, </span><span class="identifier">CONT</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-container/index.html"><span class="identifier">Container</span></a><span class="symbol">></span> <a href="state-binding.html#CONT"><span class="identifier">CONT</span></a><span class="symbol">.</span><span class="identifier">stateBinding</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.StateBinding.Companion$stateBinding(pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.CONT, pl.treksoft.kvision.redux.ReduxStore((pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.S, pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.A)), kotlin.Function2((pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.CONT, pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.S, kotlin.Unit)))/store">store</span><span class="symbol">:</span> <a href="../-redux-store/index.html"><span class="identifier">ReduxStore</span></a><span class="symbol"><</span><a href="state-binding.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="state-binding.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.StateBinding.Companion$stateBinding(pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.CONT, pl.treksoft.kvision.redux.ReduxStore((pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.S, pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.A)), kotlin.Function2((pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.CONT, pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.S, kotlin.Unit)))/factory">factory</span><span class="symbol">:</span> <a href="state-binding.html#CONT"><span class="identifier">CONT</span></a><span class="symbol">.</span><span class="symbol">(</span><a href="state-binding.html#S"><span class="identifier">S</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><span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">StateBinding</span></a><span class="symbol"><</span><a href="state-binding.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="state-binding.html#A"><span class="identifier">A</span></a><span class="symbol">,</span> <a href="state-binding.html#CONT"><span class="identifier">CONT</span></a><span class="symbol">></span></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> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.redux/-state-binding/state-binding.html b/api/pl.treksoft.kvision.redux/-state-binding/state-binding.html new file mode 100644 index 00000000..0cb98aa0 --- /dev/null +++ b/api/pl.treksoft.kvision.redux/-state-binding/state-binding.html @@ -0,0 +1,16 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StateBinding.stateBinding - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.redux</a> / <a href="index.html">StateBinding</a> / <a href="./state-binding.html">stateBinding</a><br/> +<br/> +<h1>stateBinding</h1> +<a name="pl.treksoft.kvision.redux.StateBinding.Companion$stateBinding(pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.CONT, pl.treksoft.kvision.redux.ReduxStore((pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.S, pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.A)), kotlin.Function2((pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.CONT, pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.S, kotlin.Unit)))"></a> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">S</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="identifier">A</span><span class="symbol">, </span><span class="identifier">CONT</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-container/index.html"><span class="identifier">Container</span></a><span class="symbol">></span> <a href="state-binding.html#CONT"><span class="identifier">CONT</span></a><span class="symbol">.</span><span class="identifier">stateBinding</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.StateBinding.Companion$stateBinding(pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.CONT, pl.treksoft.kvision.redux.ReduxStore((pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.S, pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.A)), kotlin.Function2((pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.CONT, pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.S, kotlin.Unit)))/store">store</span><span class="symbol">:</span> <a href="../-redux-store/index.html"><span class="identifier">ReduxStore</span></a><span class="symbol"><</span><a href="state-binding.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="state-binding.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.StateBinding.Companion$stateBinding(pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.CONT, pl.treksoft.kvision.redux.ReduxStore((pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.S, pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.A)), kotlin.Function2((pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.CONT, pl.treksoft.kvision.redux.StateBinding.Companion.stateBinding.S, kotlin.Unit)))/factory">factory</span><span class="symbol">:</span> <a href="state-binding.html#CONT"><span class="identifier">CONT</span></a><span class="symbol">.</span><span class="symbol">(</span><a href="state-binding.html#S"><span class="identifier">S</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><span class="symbol">)</span><span class="symbol">: </span><a href="index.html"><span class="identifier">StateBinding</span></a><span class="symbol"><</span><a href="state-binding.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="state-binding.html#A"><span class="identifier">A</span></a><span class="symbol">,</span> <a href="state-binding.html#CONT"><span class="identifier">CONT</span></a><span class="symbol">></span></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.redux/-state-binding/update.html b/api/pl.treksoft.kvision.redux/-state-binding/update.html new file mode 100644 index 00000000..4b34b1ed --- /dev/null +++ b/api/pl.treksoft.kvision.redux/-state-binding/update.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StateBinding.update - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.redux</a> / <a href="index.html">StateBinding</a> / <a href="./update.html">update</a><br/> +<br/> +<h1>update</h1> +<a name="pl.treksoft.kvision.redux.StateBinding$update(pl.treksoft.kvision.redux.StateBinding.S)"></a> +<code><span class="keyword">fun </span><span class="identifier">update</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.StateBinding$update(pl.treksoft.kvision.redux.StateBinding.S)/state">state</span><span class="symbol">:</span> <a href="index.html#S"><span class="identifier">S</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>Updates view from the current state.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.redux/create-redux-store.html b/api/pl.treksoft.kvision.redux/create-redux-store.html new file mode 100644 index 00000000..cf75fdaf --- /dev/null +++ b/api/pl.treksoft.kvision.redux/create-redux-store.html @@ -0,0 +1,22 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>createReduxStore - kvision</title> +<link rel="stylesheet" href="../../style.css"> +</HEAD> +<BODY> +<a href="../index.html">kvision</a> / <a href="index.html">pl.treksoft.kvision.redux</a> / <a href="./create-redux-store.html">createReduxStore</a><br/> +<br/> +<h1>createReduxStore</h1> +<a name="pl.treksoft.kvision.redux$createReduxStore(((pl.treksoft.kvision.redux.createReduxStore.S, pl.treksoft.kvision.redux.createReduxStore.A)), pl.treksoft.kvision.redux.createReduxStore.S, kotlin.Array((kotlin.Any)))"></a> +<code><span class="keyword">inline</span> <span class="keyword">fun </span><span class="symbol"><</span><span class="keyword">reified</span> <span class="identifier">S</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="identifier">A</span><span class="symbol">></span> <span class="identifier">createReduxStore</span><span class="symbol">(</span><span class="keyword">noinline</span> <span class="identifier" id="pl.treksoft.kvision.redux$createReduxStore(((pl.treksoft.kvision.redux.createReduxStore.S, pl.treksoft.kvision.redux.createReduxStore.A)), pl.treksoft.kvision.redux.createReduxStore.S, kotlin.Array((kotlin.Any)))/reducer">reducer</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="create-redux-store.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="create-redux-store.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux$createReduxStore(((pl.treksoft.kvision.redux.createReduxStore.S, pl.treksoft.kvision.redux.createReduxStore.A)), pl.treksoft.kvision.redux.createReduxStore.S, kotlin.Array((kotlin.Any)))/initialState">initialState</span><span class="symbol">:</span> <a href="create-redux-store.html#S"><span class="identifier">S</span></a><span class="symbol">, </span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.redux$createReduxStore(((pl.treksoft.kvision.redux.createReduxStore.S, pl.treksoft.kvision.redux.createReduxStore.A)), pl.treksoft.kvision.redux.createReduxStore.S, kotlin.Array((kotlin.Any)))/middlewares">middlewares</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span><span class="symbol">: </span><a href="-redux-store/index.html"><span class="identifier">ReduxStore</span></a><span class="symbol"><</span><a href="create-redux-store.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="create-redux-store.html#A"><span class="identifier">A</span></a><span class="symbol">></span></code> +<p>An inline helper function for creating Redux store.</p> +<h3>Parameters</h3> +<p><a name="reducer"></a> +<code>reducer</code> - a reducer function</p> +<p><a name="state"></a> +<code>state</code> - an initial state</p> +<p><a name="middlewares"></a> +<code>middlewares</code> - a list of optional Redux JS middlewares</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.redux/index.html b/api/pl.treksoft.kvision.redux/index.html new file mode 100644 index 00000000..2aebb7bf --- /dev/null +++ b/api/pl.treksoft.kvision.redux/index.html @@ -0,0 +1,69 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>pl.treksoft.kvision.redux - kvision</title> +<link rel="stylesheet" href="../../style.css"> +</HEAD> +<BODY> +<a href="../index.html">kvision</a> / <a href="./index.html">pl.treksoft.kvision.redux</a><br/> +<br/> +<h2>Package pl.treksoft.kvision.redux</h2> +<h3>Types</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-redux-store/index.html">ReduxStore</a></p> +</td> +<td> +<code><span class="keyword">class </span><span class="identifier">ReduxStore</span><span class="symbol"><</span><span class="identifier">S</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="identifier">A</span><span class="symbol">></span></code> +<p>A class implementing redux pattern backed by the original Redux JS library. +It requires @Serializable state.</p> +</td> +</tr> +<tr> +<td> +<p><a href="-state-binding/index.html">StateBinding</a></p> +</td> +<td> +<code><span class="keyword">class </span><span class="identifier">StateBinding</span><span class="symbol"><</span><span class="identifier">S</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="identifier">A</span><span class="symbol">, </span><span class="identifier">CONT</span> <span class="symbol">:</span> <a href="../pl.treksoft.kvision.core/-container/index.html"><span class="identifier">Container</span></a><span class="symbol">></span> <span class="symbol">:</span> <a href="../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>A class which binds the redux store with the given container.</p> +</td> +</tr> +</tbody> +</table> +<h3>Type Aliases</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-dispatch.html">Dispatch</a></p> +</td> +<td> +<code><span class="keyword">typealias </span><span class="identifier">Dispatch</span><span class="symbol"><</span><span class="identifier">A</span><span class="symbol">></span> <span class="symbol">=</span> <span class="symbol">(</span><a href="-dispatch.html#A"><span class="identifier">A</span></a><span class="symbol">)</span> <span class="symbol">-></span> <span class="identifier"><ERROR CLASS></span></code></td> +</tr> +<tr> +<td> +<p><a href="-get-state.html">GetState</a></p> +</td> +<td> +<code><span class="keyword">typealias </span><span class="identifier">GetState</span><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span> <span class="symbol">=</span> <span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="-get-state.html#S"><span class="identifier">S</span></a></code></td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="create-redux-store.html">createReduxStore</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">S</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="identifier">A</span><span class="symbol">></span> <span class="identifier">createReduxStore</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux$createReduxStore(((pl.treksoft.kvision.redux.createReduxStore.S, pl.treksoft.kvision.redux.createReduxStore.A)), pl.treksoft.kvision.redux.createReduxStore.S, kotlin.Array((kotlin.Any)))/reducer">reducer</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="create-redux-store.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="create-redux-store.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux$createReduxStore(((pl.treksoft.kvision.redux.createReduxStore.S, pl.treksoft.kvision.redux.createReduxStore.A)), pl.treksoft.kvision.redux.createReduxStore.S, kotlin.Array((kotlin.Any)))/initialState">initialState</span><span class="symbol">:</span> <a href="create-redux-store.html#S"><span class="identifier">S</span></a><span class="symbol">, </span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.redux$createReduxStore(((pl.treksoft.kvision.redux.createReduxStore.S, pl.treksoft.kvision.redux.createReduxStore.A)), pl.treksoft.kvision.redux.createReduxStore.S, kotlin.Array((kotlin.Any)))/middlewares">middlewares</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span><span class="symbol">: </span><a href="-redux-store/index.html"><span class="identifier">ReduxStore</span></a><span class="symbol"><</span><a href="create-redux-store.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="create-redux-store.html#A"><span class="identifier">A</span></a><span class="symbol">></span></code> +<p>An inline helper function for creating Redux store.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> |