kvision-bootstrap-select/io.kvision.form.select/Select

Select

open class ~~Select~~(options: List<<Error class: unknown class>>? = null, value: String? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false, init: Select.() -> Unit? = null)

Deprecated

Use TomSelect instead from the kvision-tom-select module. The library that this component is based on is no longer maintained and this module will be removed in KVision 6.

The form field 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.

Parameters

options

an optional list of options (value to label pairs) for the select control

value

selected value

name

the name attribute of the generated HTML input element

multiple

allows multiple value selection (multiple values are comma delimited)

ajaxOptions

additional options for remote (AJAX) data source

label

label text bound to the input element

rich

determines if label can contain HTML code

init

an initializer extension function

Constructors

Select

fun Select(options: List<<Error class: unknown class>>? = null, value: String? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false, init: Select.() -> Unit? = null)

Types

Companion

object Companion

Functions

add

open fun add(child: <Error class: unknown class>): Select

open fun add(position: Int, child: <Error class: unknown class>): Select

addAll

open fun addAll(children: List<<Error class: unknown class>>): Select

blur

open fun blur()

buildClassSet

open fun buildClassSet(classSetBuilder: <Error class: unknown class>)

disposeAll

open fun disposeAll(): Select

focus

open fun focus()

getChildren

open fun getChildren(): List<<Error class: unknown class>>

getState

open fun getState(): String?

hideOptions

open fun hideOptions()

Hides dropdown with options.

remove

open fun remove(child: <Error class: unknown class>): Select

removeAll

open fun removeAll(): Select

removeAt

open fun removeAt(position: Int): Select

removeEventListener

open fun removeEventListener(id: Int): <Error class: unknown class>

removeEventListeners

open fun removeEventListeners(): <Error class: unknown class>

setEventListener

open fun <T> setEventListener(block: <Error class: unknown class><T>.() -> Unit): Int

setState

open fun setState(state: String?)

showOptions

open fun showOptions()

Opens dropdown with options.

open fun subscribe(observer: (String?) -> Unit): () -> Unit

toggleOptions

open fun toggleOptions()

Toggles visibility of dropdown with options.

Properties

ajaxOptions

var ajaxOptions: <Error class: unknown class>

Additional options for remote (AJAX) data source.

autofocus

var autofocus: Boolean?

Determines if the select is automatically focused.

dropdownAlign

var dropdownAlign: <Error class: unknown class>

The dropdown align of the select control.

dropdownShowAll

var dropdownShowAll: <Error class: unknown class>

Always show all options in the dropdown list.

dropdownSize

var dropdownSize: Int?

The number of options to be show in the dropdown list.

emptyOption

var emptyOption: <Error class: unknown class>

Determines if an empty option is automatically generated.

flabel

val flabel: <Error class: unknown class>

input

val input: SelectInput

invalidFeedback

val invalidFeedback: <Error class: unknown class>

label

var label: <Error class: unknown class>

The label text bound to the select element.

liveSearch

var liveSearch: <Error class: unknown class>

Determines if live search is available.

maxOptions

var maxOptions: Int?

Maximal number of selected options.

multiple

var multiple: <Error class: unknown class>

Determines if multiple value selection is allowed.

options

var options: <Error class: unknown class>

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

placeholder

var placeholder: String?

The placeholder for the select control.

rich

var rich: <Error class: unknown class>

Determines if label can contain HTML code.

selectedIndex

var selectedIndex: Int

The index of the currently selected option or -1 if none.

selectedLabel

var selectedLabel: String?

The label of the currently selected option.

selectWidth

var selectWidth: <Error class: unknown class>?

The width of the select control.

selectWidthType

var selectWidthType: SelectWidthType?

The width type of the select control.

style

var style: <Error class: unknown class>?

The style of the select control.

value

open var value: <Error class: unknown class>

A value of the selected option.

Extensions

selectOptGroup

fun Select.selectOptGroup(label: String, options: List<<Error class: unknown class>>? = null, maxOptions: Int? = null, disabled: Boolean = false, className: String? = null, init: SelectOptGroup.() -> Unit? = null): SelectOptGroup

DSL builder extension function.

selectOption

fun Select.selectOption(value: String? = null, label: String? = null, subtext: String? = null, icon: String? = null, divider: Boolean = false, disabled: Boolean = false, selected: Boolean = false, className: String? = null, init: SelectOption.() -> Unit? = null): SelectOption

DSL builder extension function.