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

SelectInput

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

Deprecated

Use TomSelectInput 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 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.

Parameters

options

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

value

selected value

multiple

allows multiple value selection (multiple values are comma delimited)

ajaxOptions

additional options for remote (AJAX) data source

className

CSS class names

init

an initializer extension function

Constructors

SelectInput

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

Types

Companion

object Companion

Functions

add

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

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

addAll

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

afterDestroy

open fun afterDestroy()

afterInsert

open fun afterInsert(node: <Error class: unknown class>)

bindAllJQueryListeners

open fun bindAllJQueryListeners()

buildAttributeSet

open fun buildAttributeSet(attributeSetBuilder: <Error class: unknown class>)

buildClassSet

open fun buildClassSet(classSetBuilder: <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>): SelectInput

removeAll

open fun removeAll(): SelectInput

removeAllJQueryListeners

open fun removeAllJQueryListeners()

removeAt

open fun removeAt(position: Int): SelectInput

render

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

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.

disabled

open var disabled: <Error class: unknown class>

Determines if the field is disabled.

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.

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.

name

open var name: String?

The name attribute of the generated HTML select element.

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.

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.

size

open var size: <Error class: unknown class>?

The size of the input.

style

var style: <Error class: unknown class>?

The style of the select control.

validationStatus

open var validationStatus: <Error class: unknown class>?

The validation status of the input.

value

open var value: <Error class: unknown class>

A value of the selected option.

Extensions

selectOptGroup

fun SelectInput.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 SelectInput.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.