From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-drop-down/index.html | 265 +++++++++++++++++++++ 1 file changed, 265 insertions(+) create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/index.html (limited to 'api1/pl.treksoft.kvision.dropdown/-drop-down/index.html') diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/index.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/index.html new file mode 100644 index 00000000..245bb51f --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/index.html @@ -0,0 +1,265 @@ + + + +DropDown - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown
+
+

DropDown

+open class DropDown : SimplePanel +

Bootstrap dropdown component.

Constructors

+ + + + + + + +

<init>

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

Properties

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

+ block +	+`var block: Boolean` + Determines if the dropdown button takes all the space horizontally. +
+ disabled +	+`var disabled: Boolean` + Determines if the dropdown is disabled. +
+ dropup +	+`var dropup: Boolean` + Determines if the dropdown is showing upwards. +
+ forNavbar +	+`val forNavbar: Boolean` + determines if the component will be used in a navbar +
+ icon +	+`var icon: String?` + The icon of the dropdown button. +
+ image +	+`var image: ResString?` + The image on the dropdown button. +
+ size +	+`var size: ButtonSize?` + The size of the dropdown button. +
+ style +	+`var style: ButtonStyle` + The style of the dropdown button. +
+ text +	+`var text: String` + Label of the dropdown button. +
+ width +	+`open var width: CssSize?` + Width of the dropdown button. +

Functions

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

+ add +	+`open fun add(child: Component): SimplePanel` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): SimplePanel` + Adds a list of components to the current container. +
+ afterInsert +	+`open fun afterInsert(node: VNode): Unit` + Method called after inserting Snabbdom vnode into the DOM. +
+ buttonId +	+`fun buttonId(): String?`
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ remove +	+`open fun remove(child: Component): SimplePanel` + Removes given component from the current container. +
+ removeAll +	+`open fun removeAll(): SimplePanel` + Removes all children from the current container. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +
+ toggle +	+`open fun toggle(): Unit` + Toggles dropdown visibility. +

Inherited Functions

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

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

Companion Object Functions

+ + + + + + + +

dropDown

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

DSL builder extension function.

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+ + -- cgit