From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- .../pl.treksoft.kvision.navbar/-navbar/-init-.html | 27 ++++ .../-navbar/add-all.html | 21 +++ .../pl.treksoft.kvision.navbar/-navbar/add.html | 21 +++ .../-navbar/get-children.html | 18 +++ .../-navbar/get-sn-class.html | 18 +++ .../pl.treksoft.kvision.navbar/-navbar/index.html | 163 +++++++++++++++++++++ .../-navbar/inverted.html | 21 +++ .../pl.treksoft.kvision.navbar/-navbar/label.html | 15 ++ .../pl.treksoft.kvision.navbar/-navbar/navbar.html | 16 ++ .../-navbar/remove-all.html | 18 +++ .../pl.treksoft.kvision.navbar/-navbar/remove.html | 21 +++ .../pl.treksoft.kvision.navbar/-navbar/render.html | 18 +++ .../pl.treksoft.kvision.navbar/-navbar/type.html | 21 +++ 13 files changed, 398 insertions(+) create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar/add-all.html create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar/add.html create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar/get-children.html create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar/get-sn-class.html create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar/index.html create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar/inverted.html create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar/label.html create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar/navbar.html create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar/remove-all.html create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar/remove.html create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar/render.html create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar/type.html (limited to 'api/kvision/pl.treksoft.kvision.navbar/-navbar') diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar/-init-.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar/-init-.html new file mode 100644 index 00000000..34af742b --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar/-init-.html @@ -0,0 +1,27 @@ + + + +Navbar.<init> - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / <init>
+
+

<init>

+ +

Navbar(label: String? = null, type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: Navbar.() -> Unit = null)

Parameters

+label - the navbar label

+type - the navbar type

+inverted - determines if the navbar is inverted

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar/add-all.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar/add-all.html new file mode 100644 index 00000000..dcf58080 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar/add-all.html @@ -0,0 +1,21 @@ + + + +Navbar.addAll - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / addAll
+
+

addAll

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

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

+children - list of child components

Return
+current container

+ + diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar/add.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar/add.html new file mode 100644 index 00000000..072282ff --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar/add.html @@ -0,0 +1,21 @@ + + + +Navbar.add - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / add
+
+

add

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

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar/get-children.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar/get-children.html new file mode 100644 index 00000000..bc644618 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar/get-children.html @@ -0,0 +1,18 @@ + + + +Navbar.getChildren - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / getChildren
+
+

getChildren

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

Overrides SimplePanel.getChildren

Returns a list of children of the current container.

Return
+list of children

+ + diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar/get-sn-class.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar/get-sn-class.html new file mode 100644 index 00000000..e8194f04 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar/get-sn-class.html @@ -0,0 +1,18 @@ + + + +Navbar.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / getSnClass
+
+

getSnClass

+ +protected open 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/api/kvision/pl.treksoft.kvision.navbar/-navbar/index.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar/index.html new file mode 100644 index 00000000..cf11a1e6 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar/index.html @@ -0,0 +1,163 @@ + + + +Navbar - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar
+
+

Navbar

+open class Navbar : SimplePanel +

The Bootstrap Navbar container.

Constructors

+ + + + + + + +

<init>

Navbar(label: String? = null, type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: Navbar.() -> Unit = null)

Properties

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

+ inverted +	+`var inverted: Boolean` + Determines if the navbar is inverted. +
+ label +	+`var label: String?` + The navbar header label. +
+ type +	+`var type: NavbarType?` + The navbar type. +

Functions

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

+ add +	+`open fun add(child: Component): Navbar` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): Navbar` + Adds a list of components to the current container. +
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ remove +	+`open fun remove(child: Component): Navbar` + Removes given component from the current container. +
+ removeAll +	+`open fun removeAll(): Navbar` + Removes all children from the current container. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +

Inherited Functions

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

+ 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. +

Companion Object Functions

+ + + + + + + +

navbar

fun Container.navbar(label: String? = null, type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: Navbar.() -> Unit = null): Navbar

DSL builder extension function.

+ + diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar/inverted.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar/inverted.html new file mode 100644 index 00000000..233f0082 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar/inverted.html @@ -0,0 +1,21 @@ + + + +Navbar.inverted - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / inverted
+
+

inverted

+ +var inverted: Boolean +

Determines if the navbar is inverted.

Getter
+

Determines if the navbar is inverted.

Setter
+

Determines if the navbar is inverted.

+ + diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar/label.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar/label.html new file mode 100644 index 00000000..4b2fc0b9 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar/label.html @@ -0,0 +1,15 @@ + + + +Navbar.label - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / label
+
+

label

+ +var label: String? +

The navbar header label.

+ + diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar/navbar.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar/navbar.html new file mode 100644 index 00000000..8754bdd0 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar/navbar.html @@ -0,0 +1,16 @@ + + + +Navbar.navbar - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / navbar
+
+

navbar

+ +

fun Container.navbar(label: String? = null, type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: Navbar.() -> Unit = null): Navbar

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

+ + diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar/remove-all.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar/remove-all.html new file mode 100644 index 00000000..fffc78b4 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar/remove-all.html @@ -0,0 +1,18 @@ + + + +Navbar.removeAll - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / removeAll
+
+

removeAll

+ +open fun removeAll(): Navbar +

Overrides SimplePanel.removeAll

Removes all children from the current container.

Return
+current container

+ + diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar/remove.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar/remove.html new file mode 100644 index 00000000..071c25d8 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar/remove.html @@ -0,0 +1,21 @@ + + + +Navbar.remove - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / remove
+
+

remove

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

Overrides SimplePanel.remove

Removes given component from the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar/render.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar/render.html new file mode 100644 index 00000000..6c05f600 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar/render.html @@ -0,0 +1,18 @@ + + + +Navbar.render - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / render
+
+

render

+ +protected open fun render(): VNode +

Overrides SimplePanel.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ + diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar/type.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar/type.html new file mode 100644 index 00000000..09729122 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar/type.html @@ -0,0 +1,21 @@ + + + +Navbar.type - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / type
+
+

type

+ +var type: NavbarType? +

The navbar type.

Getter
+

The navbar type.

Setter
+

The navbar type.

+ + -- cgit