From 0365722f8549ee93918be99da1b9f901cf0b2c8d Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 13 Mar 2020 01:05:20 +0100 Subject: API documentation for KVision 3.5.2 --- api/pl.treksoft.kvision.navbar/-navbar/-init-.html | 2 +- .../-navbar/add-all.html | 3 +- api/pl.treksoft.kvision.navbar/-navbar/add.html | 3 +- .../-navbar/bg-color.html | 2 +- api/pl.treksoft.kvision.navbar/-navbar/expand.html | 2 +- .../-navbar/get-children.html | 3 +- .../-navbar/get-sn-class.html | 3 +- api/pl.treksoft.kvision.navbar/-navbar/index.html | 713 ++++++++++----------- api/pl.treksoft.kvision.navbar/-navbar/label.html | 2 +- api/pl.treksoft.kvision.navbar/-navbar/link.html | 2 +- .../-navbar/n-color.html | 2 +- .../-navbar/remove-all.html | 3 +- api/pl.treksoft.kvision.navbar/-navbar/remove.html | 3 +- api/pl.treksoft.kvision.navbar/-navbar/render.html | 3 +- api/pl.treksoft.kvision.navbar/-navbar/type.html | 2 +- 15 files changed, 357 insertions(+), 391 deletions(-) (limited to 'api/pl.treksoft.kvision.navbar/-navbar') diff --git a/api/pl.treksoft.kvision.navbar/-navbar/-init-.html b/api/pl.treksoft.kvision.navbar/-navbar/-init-.html index 062d59e7..71f5fb6b 100644 --- a/api/pl.treksoft.kvision.navbar/-navbar/-init-.html +++ b/api/pl.treksoft.kvision.navbar/-navbar/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.navbar / Navbar / <init>

<init>

- +(js) Navbar(label: String? = null, link: String? = null, type: NavbarType? = null, expand: NavbarExpand? = NavbarExpand.LG, nColor: NavbarColor = NavbarColor.LIGHT, bgColor: BsBgColor = BsBgColor.LIGHT, collapseOnClick: Boolean = false, classes: Set<String> = setOf(), init: (Navbar.() -> Unit)? = null)

Parameters

diff --git a/api/pl.treksoft.kvision.navbar/-navbar/add-all.html b/api/pl.treksoft.kvision.navbar/-navbar/add-all.html index dcf58080..707e2335 100644 --- a/api/pl.treksoft.kvision.navbar/-navbar/add-all.html +++ b/api/pl.treksoft.kvision.navbar/-navbar/add-all.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.navbar / Navbar / addAll

addAll

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

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.navbar/-navbar/add.html b/api/pl.treksoft.kvision.navbar/-navbar/add.html index 072282ff..a8c9f1e1 100644 --- a/api/pl.treksoft.kvision.navbar/-navbar/add.html +++ b/api/pl.treksoft.kvision.navbar/-navbar/add.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.navbar / Navbar / add

add

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

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.navbar/-navbar/bg-color.html b/api/pl.treksoft.kvision.navbar/-navbar/bg-color.html index f3c5e42b..7ef73f02 100644 --- a/api/pl.treksoft.kvision.navbar/-navbar/bg-color.html +++ b/api/pl.treksoft.kvision.navbar/-navbar/bg-color.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.navbar / Navbar / bgColor

bgColor

- +(js) var bgColor: BsBgColor

The navbar background color.

Getter
diff --git a/api/pl.treksoft.kvision.navbar/-navbar/expand.html b/api/pl.treksoft.kvision.navbar/-navbar/expand.html index 03621867..cbe08ef2 100644 --- a/api/pl.treksoft.kvision.navbar/-navbar/expand.html +++ b/api/pl.treksoft.kvision.navbar/-navbar/expand.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.navbar / Navbar / expand

expand

- +(js) var expand: NavbarExpand?

The navbar responsive behavior.

Getter
diff --git a/api/pl.treksoft.kvision.navbar/-navbar/get-children.html b/api/pl.treksoft.kvision.navbar/-navbar/get-children.html index bc644618..0e4411f0 100644 --- a/api/pl.treksoft.kvision.navbar/-navbar/get-children.html +++ b/api/pl.treksoft.kvision.navbar/-navbar/get-children.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.navbar / Navbar / getChildren

getChildren

- +(js) 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/pl.treksoft.kvision.navbar/-navbar/get-sn-class.html b/api/pl.treksoft.kvision.navbar/-navbar/get-sn-class.html index e8194f04..6dc45950 100644 --- a/api/pl.treksoft.kvision.navbar/-navbar/get-sn-class.html +++ b/api/pl.treksoft.kvision.navbar/-navbar/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.navbar / Navbar / getSnClass

getSnClass

- +(js) 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/pl.treksoft.kvision.navbar/-navbar/index.html b/api/pl.treksoft.kvision.navbar/-navbar/index.html index 8ba25a54..2411badd 100644 --- a/api/pl.treksoft.kvision.navbar/-navbar/index.html +++ b/api/pl.treksoft.kvision.navbar/-navbar/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.navbar / Navbar

Navbar

-open class Navbar : SimplePanel +(js) open class Navbar : SimplePanel

The Bootstrap Navbar container.

Constructors

@@ -27,69 +28,57 @@ +var bgColor: BsBgColor +var expand: NavbarExpand? +var label: String? +var link: String? +var nColor: NavbarColor - - -
-

<init>

+(js) +

<init>

 Navbar(label: String? = null, link: String? = null, type: NavbarType? = null, expand: NavbarExpand? = NavbarExpand.LG, nColor: NavbarColor = NavbarColor.LIGHT, bgColor: BsBgColor = BsBgColor.LIGHT, collapseOnClick: Boolean = false, classes: Set<String> = setOf(), init: (Navbar.() -> Unit)? = null)
-

bgColor

+(js) +

bgColor

 -var bgColor: BsBgColor

The navbar background color.

-
-

expand

+(js) +

expand

 -var expand: NavbarExpand?

The navbar responsive behavior.

-
-

label

+(js) +

label

 -var label: String?

The navbar header label.

-
-

link

+(js) +

link

 -var link: String?

The navbar header link.

-
-

nColor

+(js) +

nColor

 -var nColor: NavbarColor

The navbar color.

-
-

type

+(js) +

type

 -var type: NavbarType?

The navbar type.

-
-

Inherited Properties

- - - - - +var type: NavbarType?
-

children

-		 -val children: MutableList<Component>
@@ -98,89 +87,66 @@ -

add

+(js) +

add

-open fun add(child: Component): Navbar

Adds given component to the current container.

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

addAll

+(js) +

addAll

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

Adds a list of components to the current container.

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

getChildren

+(js) +

getChildren

-open fun getChildren(): List<Component>

Returns a list of children of the current container.

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

getSnClass

+(js) +

getSnClass

-open fun getSnClass(): List<StringBoolPair>

Returns list of CSS class names for current widget in the form of a List.

- +open fun getSnClass(): List<StringBoolPair> -

remove

+(js) +

remove

-open fun remove(child: Component): Navbar

Removes given component from the current container.

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

removeAll

+(js) +

removeAll

-open fun removeAll(): Navbar

Removes all children from the current container.

- +open fun removeAll(): Navbar -

render

+(js) +

render

-open fun render(): VNode

Renders current component as a Snabbdom vnode.

- - - - -

Inherited Functions

- - - - - - - - - +open fun render(): VNode
-

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.

-
@@ -189,24 +155,27 @@ -

changeFlow

+(js) +

changeFlow

-val <T : Widget> T.changeFlow: <ERROR CLASS><T> +val <T : Widget> T.changeFlow: Flow<T> -

clickFlow

+(js) +

clickFlow

-val <T : Widget> T.clickFlow: <ERROR CLASS><T> +val <T : Widget> T.clickFlow: Flow<T> -

inputFlow

+(js) +

inputFlow

-val <T : Widget> T.inputFlow: <ERROR CLASS><T> +val <T : Widget> T.inputFlow: Flow<T> @@ -215,892 +184,896 @@ -

addBsBgColor

+(js) +

addBsBgColor

fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit -

addBsBorder

+(js) +

addBsBorder

fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit -

addBsClearfix

+(js) +

addBsClearfix

fun Component.addBsClearfix(): Unit -

addBsColor

+(js) +

addBsColor

fun Component.addBsColor(bsColor: BsColor): Unit -

addBsRounded

+(js) +

addBsRounded

fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit -

bold

+(js) +

bold

-fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold

DSL builder extension function.

- +fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold -

button

+(js) +

button

-fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button

DSL builder extension function.

- +fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button -

buttonGroup

+(js) +