From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- api/pl.treksoft.kvision/-application/-init-.html | 15 +++++ api/pl.treksoft.kvision/-application/dispose.html | 17 +++++ api/pl.treksoft.kvision/-application/index.html | 78 +++++++++++++++++++++++ api/pl.treksoft.kvision/-application/start.html | 21 ++++++ 4 files changed, 131 insertions(+) create mode 100644 api/pl.treksoft.kvision/-application/-init-.html create mode 100644 api/pl.treksoft.kvision/-application/dispose.html create mode 100644 api/pl.treksoft.kvision/-application/index.html create mode 100644 api/pl.treksoft.kvision/-application/start.html (limited to 'api/pl.treksoft.kvision/-application') diff --git a/api/pl.treksoft.kvision/-application/-init-.html b/api/pl.treksoft.kvision/-application/-init-.html new file mode 100644 index 00000000..1426c1af --- /dev/null +++ b/api/pl.treksoft.kvision/-application/-init-.html @@ -0,0 +1,15 @@ + + + +Application.<init> - kvision + + + +kvision / pl.treksoft.kvision / Application / <init>
+
+

<init>

+ +Application() +

Base class for KVision applications.

+ + diff --git a/api/pl.treksoft.kvision/-application/dispose.html b/api/pl.treksoft.kvision/-application/dispose.html new file mode 100644 index 00000000..8d5f7549 --- /dev/null +++ b/api/pl.treksoft.kvision/-application/dispose.html @@ -0,0 +1,17 @@ + + + +Application.dispose - kvision + + + +kvision / pl.treksoft.kvision / Application / dispose
+
+

dispose

+ +open fun dispose(): Map<String, Any> +

Ending point for an application.

Return
+final state for Hot Module Replacement (HMR).

+ + diff --git a/api/pl.treksoft.kvision/-application/index.html b/api/pl.treksoft.kvision/-application/index.html new file mode 100644 index 00000000..ab4ea5cc --- /dev/null +++ b/api/pl.treksoft.kvision/-application/index.html @@ -0,0 +1,78 @@ + + + +Application - kvision + + + +kvision / pl.treksoft.kvision / Application
+
+

Application

+abstract class Application +

Base class for KVision applications.

Constructors

+ + + + + + + +

<init>

+Application() +

Base class for KVision applications.

Functions

+ + + + + + + + + + + +

dispose

+open fun dispose(): Map<String, Any> +

Ending point for an application.

start

+open fun start(): Unit +

Starting point for an application.

+open fun start(state: Map<String, Any>): Unit +

Starting point for an application with the state managed by Hot Module Replacement (HMR).

Extension Functions

+ + + + + + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

root

+fun Application.root(id: String, fixed: Boolean = false, init: Root.() -> Unit): Root +

Create new Root container based on ID

+fun Application.root(element: <ERROR CLASS>, fixed: Boolean = false, init: Root.() -> Unit): Root +

Create new Root container based on HTML element

+ + diff --git a/api/pl.treksoft.kvision/-application/start.html b/api/pl.treksoft.kvision/-application/start.html new file mode 100644 index 00000000..5b925e6e --- /dev/null +++ b/api/pl.treksoft.kvision/-application/start.html @@ -0,0 +1,21 @@ + + + +Application.start - kvision + + + +kvision / pl.treksoft.kvision / Application / start
+
+

start

+ +open fun start(): Unit +

Starting point for an application.

+ +open fun start(state: Map<String, Any>): Unit +

Starting point for an application with the state managed by Hot Module Replacement (HMR).

Parameters

+state - Initial state for Hot Module Replacement (HMR).

+ + -- cgit