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 --- api1/pl.treksoft.kvision.panel/-root/-init-.html | 24 ++++ api1/pl.treksoft.kvision.panel/-root/get-root.html | 14 ++ .../-root/get-sn-class.html | 18 +++ api1/pl.treksoft.kvision.panel/-root/index.html | 153 +++++++++++++++++++++ .../-root/is-first-root.html | 14 ++ api1/pl.treksoft.kvision.panel/-root/render.html | 18 +++ 6 files changed, 241 insertions(+) create mode 100644 api1/pl.treksoft.kvision.panel/-root/-init-.html create mode 100644 api1/pl.treksoft.kvision.panel/-root/get-root.html create mode 100644 api1/pl.treksoft.kvision.panel/-root/get-sn-class.html create mode 100644 api1/pl.treksoft.kvision.panel/-root/index.html create mode 100644 api1/pl.treksoft.kvision.panel/-root/is-first-root.html create mode 100644 api1/pl.treksoft.kvision.panel/-root/render.html (limited to 'api1/pl.treksoft.kvision.panel/-root') diff --git a/api1/pl.treksoft.kvision.panel/-root/-init-.html b/api1/pl.treksoft.kvision.panel/-root/-init-.html new file mode 100644 index 00000000..783c11cd --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-root/-init-.html @@ -0,0 +1,24 @@ + + + +Root.<init> - kvision + + + +kvision / pl.treksoft.kvision.panel / Root / <init>
+
+

<init>

+ +Root(id: String? = null, element: <ERROR CLASS>? = null, fixed: Boolean = false, init: (Root.() -> Unit)? = null) +

Parameters

+

+id - ID attribute of element in the main HTML file

+

+fixed - if false, the container is rendered with Bootstrap "container-fluid" class, +otherwise it's rendered with "container" class (default is false)

+

+init - an initializer extension function

+

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.panel/-root/get-root.html b/api1/pl.treksoft.kvision.panel/-root/get-root.html new file mode 100644 index 00000000..9667c2dd --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-root/get-root.html @@ -0,0 +1,14 @@ + + + +Root.getRoot - kvision + + + +kvision / pl.treksoft.kvision.panel / Root / getRoot
+
+

getRoot

+ +fun getRoot(): Root? + + diff --git a/api1/pl.treksoft.kvision.panel/-root/get-sn-class.html b/api1/pl.treksoft.kvision.panel/-root/get-sn-class.html new file mode 100644 index 00000000..ba9cf8eb --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-root/get-sn-class.html @@ -0,0 +1,18 @@ + + + +Root.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.panel / Root / getSnClass
+
+

getSnClass

+ +protected fun getSnClass(): List<StringBoolPair> +

Overrides Widget.getSnClass

+

Returns list of CSS class names for current widget in the form of a List.

+

Return
+list of CSS class names

+ + diff --git a/api1/pl.treksoft.kvision.panel/-root/index.html b/api1/pl.treksoft.kvision.panel/-root/index.html new file mode 100644 index 00000000..99089a94 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-root/index.html @@ -0,0 +1,153 @@ + + + +Root - kvision + + + +kvision / pl.treksoft.kvision.panel / Root
+
+

Root

+class Root : SimplePanel +

Root container.

+

This container is bound to the specific element in the main HTML file of the project. +It is always the root of components tree and it is responsible for rendering and updating +Snabbdom virtual DOM.

+

Constructors

+ + + + + + + +
+

<init>

+
+Root(id: String? = null, element: <ERROR CLASS>? = null, fixed: Boolean = false, init: (Root.() -> Unit)? = null)
+

Properties

+ + + + + + + +
+

isFirstRoot

+
+val isFirstRoot: Boolean
+

Functions

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

getRoot

+
+fun getRoot(): Root?
+

getSnClass

+
+fun getSnClass(): List<StringBoolPair> +

Returns list of CSS class names for current widget in the form of a List.

+
+

render

+
+fun render(): VNode +

Renders current component as a Snabbdom vnode.

+
+

Inherited Functions

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

add

+
+open fun add(child: Component): SimplePanel +

Adds given component to the current container.

+
+

addAll

+
+open fun addAll(children: List<Component>): SimplePanel +

Adds a list of components to the current container.

+
+

addInternal

+
+fun addInternal(child: Component): SimplePanel +

Protected and final method to add given component to the current container.

+
+

childrenVNodes

+
+open fun childrenVNodes(): Array<VNode> +

Returns the array of the children Snabbdom vnodes.

+
+

getChildren

+
+open fun getChildren(): List<Component> +

Returns a list of children of the current container.

+
+

remove

+
+open fun remove(child: Component): SimplePanel +

Removes given component from the current container.

+
+

removeAll

+
+open fun removeAll(): SimplePanel +

Removes all children from the current container.

+
+

Extension Functions

+ + + + + + + +
+

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

+
+ + diff --git a/api1/pl.treksoft.kvision.panel/-root/is-first-root.html b/api1/pl.treksoft.kvision.panel/-root/is-first-root.html new file mode 100644 index 00000000..6974d7f8 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-root/is-first-root.html @@ -0,0 +1,14 @@ + + + +Root.isFirstRoot - kvision + + + +kvision / pl.treksoft.kvision.panel / Root / isFirstRoot
+
+

isFirstRoot

+ +val isFirstRoot: Boolean + + diff --git a/api1/pl.treksoft.kvision.panel/-root/render.html b/api1/pl.treksoft.kvision.panel/-root/render.html new file mode 100644 index 00000000..f5a2f85a --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-root/render.html @@ -0,0 +1,18 @@ + + + +Root.render - kvision + + + +kvision / pl.treksoft.kvision.panel / Root / render
+
+

render

+ +protected fun render(): VNode +

Overrides SimplePanel.render

+

Renders current component as a Snabbdom vnode.

+

Return
+Snabbdom vnode

+ + -- cgit