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 --- .../-select-opt-group/index.html | 189 +++++++++++++++++++++ 1 file changed, 189 insertions(+) create mode 100644 api1/pl.treksoft.kvision.form.select/-select-opt-group/index.html (limited to 'api1/pl.treksoft.kvision.form.select/-select-opt-group/index.html') diff --git a/api1/pl.treksoft.kvision.form.select/-select-opt-group/index.html b/api1/pl.treksoft.kvision.form.select/-select-opt-group/index.html new file mode 100644 index 00000000..3f352b57 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.select/-select-opt-group/index.html @@ -0,0 +1,189 @@ + + + +SelectOptGroup - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOptGroup
+
+

SelectOptGroup

+open class SelectOptGroup : SimplePanel +

The helper container for adding option groups to Select.

The option group can be populated directly from options parameter or manually by adding +SelectOption components to the container.

Constructors

+ + + + + + + +

<init>

SelectOptGroup(label: String, options: List<StringPair>? = null, maxOptions: Int? = null, disabled: Boolean = false, classes: Set<String> = setOf())

Properties

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

+ disabled +	+`var disabled: Boolean` + Determines if the group is disabled. +
+ label +	+`var label: String` + A label for the group. +
+ maxOptions +	+`var maxOptions: Int?` + Maximal number of selected options in the group. +
+ options +	+`var options: List<StringPair>?` + A list of options (label to value pairs) for the group. +

Functions

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

+ getSnAttrs +	+`open fun getSnAttrs(): List<StringPair>` + Returns list of element attributes in the form of a List. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +

Inherited 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. +
+ 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. +
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ 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. +

Companion Object Functions

+ + + + + + + +

selectOptGroup

fun Select.selectOptGroup(label: String, options: List<StringPair>? = null, maxOptions: Int? = null, disabled: Boolean = false, classes: Set<String> = setOf(), init: (SelectOptGroup.() -> Unit)? = null): SelectOptGroup

fun SelectInput.selectOptGroup(label: String, options: List<StringPair>? = null, maxOptions: Int? = null, disabled: Boolean = false, classes: Set<String> = setOf(), init: (SelectOptGroup.() -> Unit)? = null): SelectOptGroup

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