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

TomSelectInput

open class TomSelectInput(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, className: String? = null, init: TomSelectInput.() -> Unit? = null)

The basic component for a select control based on Tom Select.

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

className

CSS class names

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, className: String? = null, init: TomSelectInput.() -> Unit? = null)

Properties

var autofocus: Boolean?

Determines if the text input is automatically focused.

open var disabled: <Error class: unknown class>

Determines if the field is disabled.

var disableSearch: <Error class: unknown class>

Disable searching in options.

var emptyOption: <Error class: unknown class>

Determines if an empty option is automatically generated.

var maxOptions: Int?

The number of visible options.

var multiple: <Error class: unknown class>

Determines if multiple value selection is allowed.

open var name: String?

The name attribute of the generated HTML input element.

var options: <Error class: unknown class>

A static list of options for a typeahead control

var placeholder: String?

The placeholder for the input element.

val selectedLabel: String?

The label of the currently selected option.

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

The size of the input.

var tomSelectJs: TomSelectJs?

The native TomSelect object instance

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

validationStatus

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

The validation status of the input.

open var value: <Error class: unknown class>

Text input value.

Functions

open fun afterDestroy()

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

buildAttributeSet

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

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

open fun clearOptions()

Removes all unselected options from the control.

open fun getState(): String?

open fun refresh()

open fun refreshState()

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

open fun setState(state: String?)

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