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 --- .../-select-input/index.html | 833 ++++++++++----------- 1 file changed, 399 insertions(+), 434 deletions(-) (limited to 'api/pl.treksoft.kvision.form.select/-select-input/index.html') diff --git a/api/pl.treksoft.kvision.form.select/-select-input/index.html b/api/pl.treksoft.kvision.form.select/-select-input/index.html index 7f729cb6..ebaaa6bf 100644 --- a/api/pl.treksoft.kvision.form.select/-select-input/index.html +++ b/api/pl.treksoft.kvision.form.select/-select-input/index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / SelectInput

SelectInput

-open class SelectInput : SimplePanel, FormInput +(js) open class SelectInput : SimplePanel, FormInput

The basic component for Select control.

The select control can be populated directly from options parameter or manually by adding SelectOption or SelectOptGroup components to the container.

@@ -17,7 +17,8 @@ -

<init>

+(js) +

<init>

SelectInput(options: List<StringPair>? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf()) @@ -29,168 +30,156 @@ -

ajaxOptions

+(js) +

ajaxOptions

-var ajaxOptions: AjaxOptions?

Additional options for remote (AJAX) data source.

- +var ajaxOptions: AjaxOptions? -

autofocus

+(js) +

autofocus

-var autofocus: Boolean?

Determines if the select is automatically focused.

- +var autofocus: Boolean? -

disabled

+(js) +

disabled

-open var disabled: Boolean

Determines if the field is disabled.

- +open var disabled: Boolean -

dropdownAlign

+(js) +

dropdownAlign

-var dropdownAlign: SelectDropdownAlign

The dropdown align of the select control.

- +var dropdownAlign: SelectDropdownAlign -

emptyOption

+(js) +

emptyOption

-var emptyOption: Boolean

Determines if an empty option is automatically generated.

- +var emptyOption: Boolean -

liveSearch

+(js) +

liveSearch

-var liveSearch: Boolean

Determines if live search is available.

- +var liveSearch: Boolean -

maxOptions

+(js) +

maxOptions

-var maxOptions: Int?

Maximal number of selected options.

- +var maxOptions: Int? -

multiple

+(js) +

multiple

-var multiple: Boolean

Determines if multiple value selection is allowed.

- +var multiple: Boolean -

name

+(js) +

name

-open var name: String?

The name attribute of the generated HTML select element.

- +open var name: String? -

options

+(js) +

options

-var options: List<StringPair>?

A list of options (value to label pairs) for the select control.

- +var options: List<StringPair>? -

placeholder

+(js) +

placeholder

-var placeholder: String?

The placeholder for the select control.

- +var placeholder: String? -

selectWidth

+(js) +

selectWidth

-var selectWidth: CssSize?

The width of the select control.

- +var selectWidth: CssSize? -

selectWidthType

+(js) +

selectWidthType

-var selectWidthType: SelectWidthType?

The width type of the select control.

- +var selectWidthType: SelectWidthType? -

size

+(js) +

size

-open var size: InputSize?

The size of the input.

- +open var size: InputSize? -

style

+(js) +

style

-var style: ButtonStyle?

The style of the select control.

- +var style: ButtonStyle? -

validationStatus

+(js) +

validationStatus

-open var validationStatus: ValidationStatus?

The validation status of the input.

- +open var validationStatus: ValidationStatus? -

value

+(js) +

value

-var value: String?

A value of the selected option.

- - - - -

Inherited Properties

- - - - - +var value: String?
-

children

-		 -val children: MutableList<Component>
@@ -199,166 +188,136 @@ -

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 -

blur

+(js) +

blur

-open fun blur(): Unit

Makes the input element blur.

- +open fun blur(): Unit -

focus

+(js) +

focus

-open fun focus(): Unit

Makes the input element focused.

- +open fun focus(): Unit -

getSnAttrs

+(js) +

getSnAttrs

-open fun getSnAttrs(): List<StringPair>

Returns list of element attributes in the form of a List.

- +open fun getSnAttrs(): List<StringPair> -

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

hideOptions

+(js) +

hideOptions

-open fun hideOptions(): Unit

Hides dropdown with options.

- +open fun hideOptions(): Unit -

refreshSelectInput

+(js) +

refreshSelectInput

fun refreshSelectInput(): Unit -

refreshState

+(js) +

refreshState

open fun refreshState(): Unit -

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 -

render

+(js) +

render

-open fun render(): VNode

Renders current component as a Snabbdom vnode.

- +open fun render(): VNode -

showOptions

+(js) +

showOptions

-open fun showOptions(): Unit

Opens dropdown with options.

- +open fun showOptions(): Unit -

toggleOptions

+(js) +

toggleOptions

-open fun toggleOptions(): Unit

Toggles visibility of dropdown with options.

- - - - -

Inherited Functions

- - - - - - - - - - - - - +open fun toggleOptions(): 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.

-
-

getChildren

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

Returns a list of children of the current container.

-
@@ -367,24 +326,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> @@ -393,885 +355,888 @@ -

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: