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/-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 +++ 5 files changed, 219 insertions(+) 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 (limited to 'api/kvision/pl.treksoft.kvision.navbar/-nav') 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.<init> - 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

+ + + + + + + +

<init>

+Nav(rightAlign: Boolean = false, classes: Set<String> = setOf(), init: Nav.() -> Unit = null)

Properties

+ + + + + + + +

rightAlign

+var rightAlign: Boolean +

Determines if the nav is aligned to the right.

Inherited Properties

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

+ align +	+`var align: Align?` + Text align. +
+ content +	+`open var content: String?` + Text content of the tag. +
+ rich +	+`open var rich: Boolean` + Determines if content can contain HTML code. +
+ template +	+`open var template: (Any?) -> String` + Handlebars template. +
+ templates +	+`open var templates: Map<String, (Any?) -> String>` + Handlebars templates for i18n. +
+ type +	+`var type: TAG` + Tag type. +

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

+ + + + + + + +

nav

+fun Navbar.nav(rightAlign: Boolean = false, classes: Set<String> = setOf(), init: Nav.() -> Unit = null): Nav +

DSL builder extension function.

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

+ + -- cgit