kvision / pl.treksoft.kvision.form.select / SelectInput

SelectInput

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.

Constructors

<init>

SelectInput(options: List<StringPair>? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf())

Properties

ajaxOptions

var ajaxOptions: AjaxOptions?

Additional options for remote (AJAX) data source.

autofocus

var autofocus: Boolean?

Determines if the select is automatically focused.

disabled

open var disabled: Boolean

Determines if the field is disabled.

emptyOption

var emptyOption: Boolean

Determines if an empty option is automatically generated.

liveSearch

var liveSearch: Boolean

Determines if live search is available.

maxOptions

var maxOptions: Int?

Maximal number of selected options.

multiple

var multiple: Boolean

Determines if multiple value selection is allowed.

name

open var name: String?

The name attribute of the generated HTML select element.

options

var options: List<StringPair>?

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

placeholder

var placeholder: String?

The placeholder for the select control.

selectWidth

var selectWidth: CssSize?

The width of the select control.

selectWidthType

var selectWidthType: SelectWidthType?

The width type of the select control.

size

open var size: InputSize?

The size of the input.

style

var style: ButtonStyle?

The style of the select control.

value

var value: String?

A value of the selected option.

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.

blur

open fun blur(): Unit

Makes the input element blur.

focus

open fun focus(): Unit

Makes the input element focused.

getSnAttrs

open fun getSnAttrs(): List<StringPair>

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

getSnClass

open fun getSnClass(): List<StringBoolPair>

Returns list of CSS class names for current widget in the form of a List.

hideOptions

open fun hideOptions(): Unit

Hides dropdown with options.

refreshSelectInput

fun refreshSelectInput(): Unit

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.

showOptions

open fun showOptions(): Unit

Opens dropdown with options.

toggleOptions

open fun toggleOptions(): Unit

Toggles visibility of dropdown with options.

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.

getChildren

open fun getChildren(): List<Component>

Returns a list of children of the current container.

Companion Object Functions

selectInput

fun Container.selectInput(options: List<StringPair>? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf(), init: (SelectInput.() -> Unit)? = null): SelectInput

DSL builder extension function.

Extension Functions

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

Inheritors

SelectRemoteInput

open class SelectRemoteInput<T : Any> : SelectInput

The Select control connected to the multiplatform service.