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/index.html | 153 ++++++++++++++++++++++++ 1 file changed, 153 insertions(+) create mode 100644 api1/pl.treksoft.kvision.panel/-root/index.html (limited to 'api1/pl.treksoft.kvision.panel/-root/index.html') 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.

+ + -- cgit