From 806edfceeefe7fda47924f97237974e99fe28a02 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 2 Apr 2018 01:35:47 +0200 Subject: API documentantion update --- .../-drop-down/-init-.html | 6 +++-- .../-drop-down/drop-down.html | 4 +-- .../-drop-down/for-navbar.html | 15 +++++++++++ .../-drop-down/index.html | 31 ++++++++++++++-------- .../-drop-down/render.html | 18 +++++++++++++ 5 files changed, 59 insertions(+), 15 deletions(-) create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/render.html (limited to 'api/pl.treksoft.kvision.dropdown/-drop-down') diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html b/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html index 05279737..ccb09c31 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / <init>

<init>

- -

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, classes: Set<String> = setOf())

+ +

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, classes: Set<String> = setOf())

Parameters

text - the label of the dropdown button

@@ -21,6 +21,8 @@ style - the style of the dropdown button

disabled - determines if the component is disabled on start

+forNavbar - determines if the component will be used in a navbar

classes - a set of CSS class names

Constructor
diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html b/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html index 7c88d682..84df9354 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / dropDown

dropDown

- -

fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, classes: Set<String> = setOf(), init: DropDown.() -> Unit = null): DropDown

+ +

fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, classes: Set<String> = setOf(), init: DropDown.() -> Unit = null): DropDown

DSL builder extension function.

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

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html b/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html new file mode 100644 index 00000000..33497640 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html @@ -0,0 +1,15 @@ + + + +DropDown.forNavbar - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / forNavbar
+
+

forNavbar

+ +val forNavbar: Boolean +

determines if the component will be used in a navbar

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/index.html b/api/pl.treksoft.kvision.dropdown/-drop-down/index.html index f9330ef4..6dbac1d8 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/index.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/index.html @@ -18,7 +18,7 @@

<init>

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, classes: Set<String> = setOf())

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, classes: Set<String> = setOf())

@@ -54,6 +54,15 @@ +

forNavbar

+ + +val forNavbar: Boolean +

determines if the component will be used in a navbar

+ + + +

icon

@@ -176,6 +185,15 @@ +

render

+ + +open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+ + + +

toggle

@@ -206,15 +224,6 @@

Returns the array of the children Snabbdom vnodes.

- - -

render

- - -open fun render(): VNode -

Renders current component as a Snabbdom vnode.

- -

Companion Object Functions

@@ -225,7 +234,7 @@

dropDown

fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, classes: Set<String> = setOf(), init: DropDown.() -> Unit = null): DropDown

fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, classes: Set<String> = setOf(), init: DropDown.() -> Unit = null): DropDown

DSL builder extension function.

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/render.html b/api/pl.treksoft.kvision.dropdown/-drop-down/render.html new file mode 100644 index 00000000..6f4b3a6b --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/render.html @@ -0,0 +1,18 @@ + + + +DropDown.render - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / render
+
+

render

+ +protected open fun render(): VNode +

Overrides SimplePanel.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ + -- cgit