kvision-tom-select/io.kvision.form.select/TomSelect

TomSelect

open class TomSelect(options: List<<Error class: unknown class>>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, maxOptions: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, label: String? = null, rich: Boolean = false, init: TomSelect.() -> Unit? = null)

The form field component for Tom Select control.

Parameters

options

a static list of options

value

text input value

emptyOption

determines if an empty option is automatically generated

multiple

allows multiple value selection (multiple values are comma delimited)

maxOptions

the number of visible options

tsOptions

Tom Select options

tsCallbacks

Tom Select callbacks

tsRenders

Tom Select render functions

label

label text bound to the input element

rich

determines if label can contain HTML code

init

an initializer extension function

Constructors

constructor(options: List<<Error class: unknown class>>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, maxOptions: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, label: String? = null, rich: Boolean = false, init: TomSelect.() -> Unit? = null)

Types

object Companion

Properties

var autofocus: Boolean?

Determines if the select is automatically focused.

var disableSearch: <Error class: unknown class>

Disable searching in options.

var emptyOption: <Error class: unknown class>

Determines if an empty option is automatically generated.

val flabel: <Error class: unknown class>

val input: TomSelectInput

invalidFeedback

val invalidFeedback: <Error class: unknown class>

var label: <Error class: unknown class>

The label text bound to the select element.

var maxOptions: Int?

The number of visible options.

var multiple: <Error class: unknown class>

Determines if multiple value selection is allowed.

var options: <Error class: unknown class>

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

var placeholder: String?

The placeholder for the select control.

var rich: <Error class: unknown class>

Determines if label can contain HTML code.

val selectedLabel: String?

The label of the currently selected option.

var tsCallbacks: <Error class: unknown class>

Tom Select callbacks

var tsOptions: <Error class: unknown class>

Tom Select options

var tsRenders: <Error class: unknown class>

Tom Select render functions

open var value: <Error class: unknown class>

A value of the selected option.

Functions

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

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

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

open fun blur()

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

open fun clearOptions()

Removes all unselected options from the control.

open fun disposeAll()

open fun focus()

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

open fun getState(): String?

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

open fun removeAll()

open fun removeAt(position: Int)

removeEventListener

open fun removeEventListener(id: Int)

removeEventListeners

open fun removeEventListeners()

setEventListener

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

open fun setState(state: String?)

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