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/index.html | 770 ++++++++++----------- 1 file changed, 367 insertions(+), 403 deletions(-) (limited to 'api/pl.treksoft.kvision.dropdown/-drop-down/index.html') 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(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) +

buttonGroup

-fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String> = setOf(), init: (ButtonGroup.() -> Unit)? = null): ButtonGroup

DSL builder extension function.

- +fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String> = setOf(), init: (ButtonGroup.() -> Unit)? = null): ButtonGroup -

canvas

+(js) +

canvas

-fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf(), init: (Canvas.() -> Unit)? = null): Canvas

DSL builder extension function.

- +fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int