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
---
.../-nav-form/-init-.html | 23 +++
.../-nav-form/get-sn-class.html | 18 +++
.../-nav-form/index.html | 141 ++++++++++++++++++
.../-nav-form/nav-form.html | 16 ++
.../-nav-form/right-align.html | 21 +++
.../pl.treksoft.kvision.navbar/-nav/-init-.html | 23 +++
.../-nav/get-sn-class.html | 18 +++
.../pl.treksoft.kvision.navbar/-nav/index.html | 141 ++++++++++++++++++
.../pl.treksoft.kvision.navbar/-nav/nav.html | 16 ++
.../-nav/right-align.html | 21 +++
.../-navbar-type/-f-i-x-e-d-b-o-t-t-o-m.html | 14 ++
.../-navbar-type/-f-i-x-e-d-t-o-p.html | 14 ++
.../-navbar-type/-s-t-a-t-i-c-t-o-p.html | 14 ++
.../-navbar-type/index.html | 40 +++++
.../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 +++
api/kvision/pl.treksoft.kvision.navbar/index.html | 54 +++++++
28 files changed, 972 insertions(+)
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-nav-form/-init-.html
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-nav-form/get-sn-class.html
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-nav-form/index.html
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-nav-form/nav-form.html
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-nav-form/right-align.html
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-nav/-init-.html
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-nav/get-sn-class.html
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-nav/index.html
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-nav/nav.html
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-nav/right-align.html
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar-type/-f-i-x-e-d-b-o-t-t-o-m.html
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar-type/-f-i-x-e-d-t-o-p.html
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar-type/-s-t-a-t-i-c-t-o-p.html
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/-navbar-type/index.html
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
create mode 100644 api/kvision/pl.treksoft.kvision.navbar/index.html
(limited to 'api/kvision/pl.treksoft.kvision.navbar')
diff --git a/api/kvision/pl.treksoft.kvision.navbar/-nav-form/-init-.html b/api/kvision/pl.treksoft.kvision.navbar/-nav-form/-init-.html
new file mode 100644
index 00000000..475c2750
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-nav-form/-init-.html
@@ -0,0 +1,23 @@
+
+
+
+NavForm. - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / NavForm / <init>
+
+<init>
+
+NavForm(rightAlign: Boolean = false, classes: Set<String> = setOf(), init: NavForm.() -> Unit = null)
+Parameters
+
+rightAlign - determines if the nav form is aligned to the right
+
+classes - a set of CSS class names
+
+init - an initializer extension function
+Constructor
+
+
+
diff --git a/api/kvision/pl.treksoft.kvision.navbar/-nav-form/get-sn-class.html b/api/kvision/pl.treksoft.kvision.navbar/-nav-form/get-sn-class.html
new file mode 100644
index 00000000..9c1f8630
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-nav-form/get-sn-class.html
@@ -0,0 +1,18 @@
+
+
+
+NavForm.getSnClass - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / NavForm / getSnClass
+
+getSnClass
+
+protected open fun getSnClass(): List<StringBoolPair>
+Overrides Tag.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/-nav-form/index.html b/api/kvision/pl.treksoft.kvision.navbar/-nav-form/index.html
new file mode 100644
index 00000000..1693a29d
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-nav-form/index.html
@@ -0,0 +1,141 @@
+
+
+
+NavForm - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / NavForm
+
+NavForm
+open class NavForm : Tag
+The Bootstrap Nav form container.
+Constructors
+
+Properties
+
+
+
+|
+ rightAlign
+ |
+
+var rightAlign: Boolean
+Determines if the nav form is aligned to the right.
+ |
+
+
+
+Inherited Properties
+
+Functions
+
+
+
+|
+ getSnClass
+ |
+
+open fun getSnClass(): List<StringBoolPair>
+Returns list of CSS class names for current widget in the form of a List.
+ |
+
+
+
+Inherited Functions
+
+
+
+|
+ render
+ |
+
+open fun render(): VNode
+Renders current component as a Snabbdom vnode.
+ |
+
+
+
+Companion Object Functions
+
+
+
diff --git a/api/kvision/pl.treksoft.kvision.navbar/-nav-form/nav-form.html b/api/kvision/pl.treksoft.kvision.navbar/-nav-form/nav-form.html
new file mode 100644
index 00000000..faed10d2
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-nav-form/nav-form.html
@@ -0,0 +1,16 @@
+
+
+
+NavForm.navForm - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / NavForm / navForm
+
+navForm
+
+fun Navbar.navForm(rightAlign: Boolean = false, classes: Set<String> = setOf(), init: NavForm.() -> Unit = null): NavForm
+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/-nav-form/right-align.html b/api/kvision/pl.treksoft.kvision.navbar/-nav-form/right-align.html
new file mode 100644
index 00000000..10f506d7
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-nav-form/right-align.html
@@ -0,0 +1,21 @@
+
+
+
+NavForm.rightAlign - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / NavForm / rightAlign
+
+rightAlign
+
+var rightAlign: Boolean
+Determines if the nav form is aligned to the right.
+Getter
+
Determines if the nav form is aligned to the right.
+
+Setter
+
Determines if the nav form is aligned to the right.
+
+
+
diff --git a/api/kvision/pl.treksoft.kvision.navbar/-nav/-init-.html b/api/kvision/pl.treksoft.kvision.navbar/-nav/-init-.html
new file mode 100644
index 00000000..8a1e9a8e
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-nav/-init-.html
@@ -0,0 +1,23 @@
+
+
+
+Nav. - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / Nav / <init>
+
+<init>
+
+Nav(rightAlign: Boolean = false, classes: Set<String> = setOf(), init: Nav.() -> Unit = null)
+Parameters
+
+rightAlign - determines if the nav is aligned to the right
+
+classes - a set of CSS class names
+
+init - an initializer extension function
+Constructor
+
+
+
diff --git a/api/kvision/pl.treksoft.kvision.navbar/-nav/get-sn-class.html b/api/kvision/pl.treksoft.kvision.navbar/-nav/get-sn-class.html
new file mode 100644
index 00000000..015896a5
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-nav/get-sn-class.html
@@ -0,0 +1,18 @@
+
+
+
+Nav.getSnClass - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / Nav / getSnClass
+
+getSnClass
+
+protected open fun getSnClass(): List<StringBoolPair>
+Overrides Tag.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/-nav/index.html b/api/kvision/pl.treksoft.kvision.navbar/-nav/index.html
new file mode 100644
index 00000000..fcc991bc
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-nav/index.html
@@ -0,0 +1,141 @@
+
+
+
+Nav - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / Nav
+
+Nav
+open class Nav : Tag
+The Bootstrap Nav container.
+Constructors
+
+Properties
+
+
+
+|
+ rightAlign
+ |
+
+var rightAlign: Boolean
+Determines if the nav is aligned to the right.
+ |
+
+
+
+Inherited Properties
+
+Functions
+
+
+
+|
+ getSnClass
+ |
+
+open fun getSnClass(): List<StringBoolPair>
+Returns list of CSS class names for current widget in the form of a List.
+ |
+
+
+
+Inherited Functions
+
+
+
+|
+ render
+ |
+
+open fun render(): VNode
+Renders current component as a Snabbdom vnode.
+ |
+
+
+
+Companion Object Functions
+
+
+
diff --git a/api/kvision/pl.treksoft.kvision.navbar/-nav/nav.html b/api/kvision/pl.treksoft.kvision.navbar/-nav/nav.html
new file mode 100644
index 00000000..98f27419
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-nav/nav.html
@@ -0,0 +1,16 @@
+
+
+
+Nav.nav - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / Nav / nav
+
+nav
+
+fun Navbar.nav(rightAlign: Boolean = false, classes: Set<String> = setOf(), init: Nav.() -> Unit = null): Nav
+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/-nav/right-align.html b/api/kvision/pl.treksoft.kvision.navbar/-nav/right-align.html
new file mode 100644
index 00000000..6ddf4b35
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-nav/right-align.html
@@ -0,0 +1,21 @@
+
+
+
+Nav.rightAlign - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / Nav / rightAlign
+
+rightAlign
+
+var rightAlign: Boolean
+Determines if the nav is aligned to the right.
+Getter
+
Determines if the nav is aligned to the right.
+
+Setter
+
Determines if the nav is aligned to the right.
+
+
+
diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar-type/-f-i-x-e-d-b-o-t-t-o-m.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar-type/-f-i-x-e-d-b-o-t-t-o-m.html
new file mode 100644
index 00000000..5742fbb3
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar-type/-f-i-x-e-d-b-o-t-t-o-m.html
@@ -0,0 +1,14 @@
+
+
+
+NavbarType.FIXEDBOTTOM - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / NavbarType / FIXEDBOTTOM
+
+FIXEDBOTTOM
+
+FIXEDBOTTOM
+
+
diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar-type/-f-i-x-e-d-t-o-p.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar-type/-f-i-x-e-d-t-o-p.html
new file mode 100644
index 00000000..d7286c5f
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar-type/-f-i-x-e-d-t-o-p.html
@@ -0,0 +1,14 @@
+
+
+
+NavbarType.FIXEDTOP - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / NavbarType / FIXEDTOP
+
+FIXEDTOP
+
+FIXEDTOP
+
+
diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar-type/-s-t-a-t-i-c-t-o-p.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar-type/-s-t-a-t-i-c-t-o-p.html
new file mode 100644
index 00000000..8d992f06
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar-type/-s-t-a-t-i-c-t-o-p.html
@@ -0,0 +1,14 @@
+
+
+
+NavbarType.STATICTOP - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / NavbarType / STATICTOP
+
+STATICTOP
+
+STATICTOP
+
+
diff --git a/api/kvision/pl.treksoft.kvision.navbar/-navbar-type/index.html b/api/kvision/pl.treksoft.kvision.navbar/-navbar-type/index.html
new file mode 100644
index 00000000..eb6e3cb0
--- /dev/null
+++ b/api/kvision/pl.treksoft.kvision.navbar/-navbar-type/index.html
@@ -0,0 +1,40 @@
+
+
+
+NavbarType - kvision
+
+
+
+kvision / pl.treksoft.kvision.navbar / NavbarType
+
+NavbarType
+enum class NavbarType
+Navbar types.
+Enum Values
+
+
+
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. - 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
+
+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
+