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 --- .../-drop-down/-init-.html | 2 +- .../-drop-down/add-all.html | 3 +- .../-drop-down/add.html | 3 +- .../-drop-down/after-insert.html | 3 +- .../-drop-down/block.html | 2 +- .../-drop-down/button-id.html | 2 +- .../-drop-down/direction.html | 2 +- .../-drop-down/disabled.html | 2 +- .../-drop-down/for-drop-down.html | 2 +- .../-drop-down/for-navbar.html | 2 +- .../-drop-down/get-children.html | 3 +- .../-drop-down/get-sn-class.html | 3 +- .../-drop-down/icon.html | 2 +- .../-drop-down/image.html | 2 +- .../-drop-down/index.html | 770 ++++++++++----------- .../-drop-down/remove-all.html | 3 +- .../-drop-down/remove.html | 3 +- .../-drop-down/size.html | 2 +- .../-drop-down/style.html | 2 +- .../-drop-down/text.html | 2 +- .../-drop-down/toggle.html | 2 +- .../-drop-down/width.html | 3 +- 22 files changed, 388 insertions(+), 432 deletions(-) (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 b888b053..34ee3495 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / <init>

<init>

- +(js) DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, direction: Direction = Direction.DROPDOWN, disabled: Boolean = false, forNavbar: Boolean = false, forDropDown: Boolean = false, classes: Set<String> = setOf())

Parameters

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html b/api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html index 464a2fea..6ce4e2a1 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / addAll

addAll

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

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/add.html b/api/pl.treksoft.kvision.dropdown/-drop-down/add.html index 85081d14..d549b282 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/add.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/add.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / add

add

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

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html b/api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html index 1b4bb89d..8ce1ac7b 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / afterInsert

afterInsert

- +(js) protected open fun afterInsert(node: VNode): Unit -

Overrides Widget.afterInsert

Method called after inserting Snabbdom vnode into the DOM.

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/block.html b/api/pl.treksoft.kvision.dropdown/-drop-down/block.html index 446d4803..75683560 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/block.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/block.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / block

block

- +(js) var block: Boolean

Determines if the dropdown button takes all the space horizontally.

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/button-id.html b/api/pl.treksoft.kvision.dropdown/-drop-down/button-id.html index abac1ea0..8c57f68c 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/button-id.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/button-id.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / buttonId

buttonId

- +(js) fun buttonId(): String? diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/direction.html b/api/pl.treksoft.kvision.dropdown/-drop-down/direction.html index f60fc025..f951a0fa 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/direction.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/direction.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / direction

direction

- +(js) var direction: Direction

The direction of the dropdown.

Getter
diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html b/api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html index 9c25d116..1c653bba 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / disabled

disabled

- +(js) var disabled: Boolean

Determines if the dropdown is disabled.

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/for-drop-down.html b/api/pl.treksoft.kvision.dropdown/-drop-down/for-drop-down.html index 5e5e2bfc..7a54b6ca 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/for-drop-down.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/for-drop-down.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / forDropDown

forDropDown

- +(js) val forDropDown: Boolean

determines if the component will be used in a dropdown

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html b/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html index 33497640..f0e19b1d 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / forNavbar

forNavbar

- +(js) val forNavbar: Boolean

determines if the component will be used in a navbar

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html b/api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html index 749b4086..7304d7de 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / 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.dropdown/-drop-down/get-sn-class.html b/api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html index c9d8031d..5aee340b 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / 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.dropdown/-drop-down/icon.html b/api/pl.treksoft.kvision.dropdown/-drop-down/icon.html index 33c4950b..8462d686 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/icon.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/icon.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / icon

icon

- +(js) var icon: String?

The icon of the dropdown button.

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/image.html b/api/pl.treksoft.kvision.dropdown/-drop-down/image.html index 56755e67..0d38f581 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/image.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/image.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / image

image

- +(js) var image: ResString?

The image on the dropdown button.

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/index.html b/api/pl.treksoft.kvision.dropdown/-drop-down/index.html index 65554515..646c6434 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/index.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.dropdown / DropDown

DropDown

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

Bootstrap dropdown component.

Constructors

@@ -27,114 +28,102 @@ +var block: Boolean +var direction: Direction +var disabled: Boolean +val forDropDown: Boolean +val forNavbar: Boolean +var icon: String? +var image: ResString? +var size: ButtonSize? +var style: ButtonStyle +var text: String - - -
-

<init>

+(js) +

<init>

 DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, direction: Direction = Direction.DROPDOWN, disabled: Boolean = false, forNavbar: Boolean = false, forDropDown: Boolean = false, classes: Set<String> = setOf())
-

block

+(js) +

block

 -var block: Boolean

Determines if the dropdown button takes all the space horizontally.

-
-

direction

+(js) +

direction

 -var direction: Direction

The direction of the dropdown.

-
-

disabled

+(js) +

disabled

 -var disabled: Boolean

Determines if the dropdown is disabled.

-
-

forDropDown

+(js) +

forDropDown

 -val forDropDown: Boolean

determines if the component will be used in a dropdown

-
-

forNavbar

+(js) +

forNavbar

 -val forNavbar: Boolean

determines if the component will be used in a navbar

-
-

icon

+(js) +

icon

 -var icon: String?

The icon of the dropdown button.

-
-

image

+(js) +

image

 -var image: ResString?

The image on the dropdown button.

-
-

size

+(js) +

size

 -var size: ButtonSize?

The size of the dropdown button.

-
-

style

+(js) +

style

 -var style: ButtonStyle

The style of the dropdown button.

-
-

text

+(js) +

text

 -var text: String

Label of the dropdown button.

-
-

width

+(js) +

width

 -open var width: CssSize?

Width of the dropdown button.

-
-

Inherited Properties

- - - - - +open var width: CssSize?
-

children

-		 -val children: MutableList<Component>
@@ -143,114 +132,83 @@ -

add

+(js) +

add

-open fun add(child: Component): SimplePanel

Adds given component to the current container.

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

addAll

+(js) +

addAll

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

Adds a list of components to the current container.

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

afterInsert

+(js) +

afterInsert

-open fun afterInsert(node: VNode): Unit

Method called after inserting Snabbdom vnode into the DOM.

- +open fun afterInsert(node: VNode): Unit -

buttonId

+(js) +

buttonId

fun buttonId(): String? -

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): SimplePanel

Removes given component from the current container.

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

removeAll

+(js) +

removeAll

-open fun removeAll(): SimplePanel

Removes all children from the current container.

- +open fun removeAll(): SimplePanel -

toggle

+(js) +

toggle

-open fun toggle(): Unit

Toggles dropdown visibility.

- - - - -

Inherited Functions

- - - - - - - - - - - - - +open fun toggle(): Unit
-

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.

-
-

render

-		 -open fun render(): VNode -

Renders current component as a Snabbdom vnode.

-
@@ -259,24 +217,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> @@ -285,903 +246,906 @@ -

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(