kvision/io.kvision.form.select

Package-level declarations

Contains a simple select component as well as full-featured components with support for remote data sources.

Types

data class AjaxOptions(val url: String? = null, val preprocessData: (dynamic) -> dynamic? = null, val beforeSend: (<Error class: unknown class>, <Error class: unknown class>) -> dynamic? = null, val data: dynamic = null, val httpType: HttpType = HttpType.GET, val dataType: DataType = DataType.JSON, val minLength: Int = 0, val cache: Boolean = true, val clearOnEmpty: Boolean = true, val clearOnError: Boolean = true, val emptyRequest: Boolean = false, val requestDelay: Int = AJAX_REQUEST_DELAY, val restoreOnError: Boolean = false, val preserveSelected: Boolean = false, val processData: Boolean = false)

Data class for AJAX options.

DataType

enum DataType : Enum<DataType>

Data type for the AJAX call.

HttpType

enum HttpType : Enum<HttpType>

HTTP protocol type for the AJAX call.

Select

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

The form field component for Select control.

SelectDropdownAlign

enum SelectDropdownAlign : Enum<SelectDropdownAlign>

Select dropdown align. See Bootstrap Select width.

SelectInput

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

The basic component for Select control.

SelectOptGroup

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

The helper container for adding option groups to Select.

SelectOption

open class 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) : Widget

The helper component for adding options to Select or SelectOptGroup.

SelectRemote

open class ~~SelectRemote~~<out T : Any>(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?, String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, preload: Boolean = false, label: String? = null, rich: Boolean = false, init: SelectRemote<T>.() -> Unit? = null) : SimplePanel, StringFormControl, MutableState<String?>

The form field component for SelectRemote control.

SelectRemoteInput

open class ~~SelectRemoteInput~~<out T : Any>(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?, String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, preload: Boolean = false, className: String? = null, init: SelectRemoteInput<T>.() -> Unit? = null) : SelectInput

The Select control connected to the fullstack service.

SelectWidthType

enum SelectWidthType : Enum<SelectWidthType>

Select width types. See Bootstrap Select width.

SimpleSelect

open class SimpleSelect(options: List<<Error class: unknown class><String, String>>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, name: String? = null, label: String? = null, rich: Boolean = false, val floating: Boolean = false, init: SimpleSelect.() -> Unit? = null) : SimplePanel, StringFormControl, MutableState<String?>

The form field component for SimpleSelect control.

SimpleSelectInput

open class SimpleSelectInput(options: List<<Error class: unknown class><String, String>>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, className: String? = null, init: SimpleSelectInput.() -> Unit? = null) : SimplePanel, GenericFormComponent<String?> , FormInput, MutableState<String?>

Simple select component.

SimpleSelectRemote

open class SimpleSelectRemote<out T : Any>(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, name: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, label: String? = null, rich: Boolean = false, init: SimpleSelectRemote<T>.() -> Unit? = null) : SimplePanel, StringFormControl, MutableState<String?>

The form field component for SelectRemote control.

SimpleSelectRemoteInput

open class SimpleSelectRemoteInput<out T : Any>(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, className: String? = null, init: SimpleSelectRemoteInput<T>.() -> Unit? = null) : SimpleSelectInput

The SimpleSelect control connected to the fullstack service.

TomSelect

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

The form field component for Tom Select control.

TomSelectCallbacks

data class TomSelectCallbacks(val load: (query: String, callback: (Array<dynamic>) -> Unit) -> Unit? = null, val shouldLoad: (query: String) -> Boolean? = null, val score: (search: String) -> (dynamic) -> Int? = null, val onInitialize: () -> Unit? = null, val onFocus: () -> Unit? = null, val onBlur: () -> Unit? = null, val onChange: (dynamic) -> Unit? = null, val onItemAdd: (dynamic, dynamic) -> Unit? = null, val onItemRemove: (dynamic) -> Unit? = null, val onClear: () -> Unit? = null, val onDelete: (dynamic, dynamic) -> Unit? = null, val onOptionAdd: (dynamic, dynamic) -> Unit? = null, val onOptionRemove: (dynamic) -> Unit? = null, val onDropdownOpen: (dynamic) -> Unit? = null, val onDropdownClose: (dynamic) -> Unit? = null, val onType: (str: String) -> Unit? = null, val onLoad: (dynamic, dynamic) -> Unit? = null)

TomSelectInput

open class TomSelectInput(options: List<<Error class: unknown class><String, String>>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, className: String? = null, init: TomSelectInput.() -> Unit? = null) : SimplePanel, GenericFormComponent<String?> , FormInput, MutableState<String?>

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

TomSelectOptions

data class TomSelectOptions(val create: Boolean? = null, val createFun: (input: String, callback: (<Error class: unknown class><String, String>) -> Unit) -> Unit? = null, val createOnBlur: Boolean? = null, val createFilter: String? = null, val highlight: Boolean? = null, val persist: Boolean? = null, val openOnFocus: Boolean? = null, val maxItems: Int? = null, val hideSelected: Boolean? = null, val closeAfterSelect: Boolean? = null, val loadThrottle: Int? = null, val loadingClass: String? = null, val hidePlaceholder: Boolean? = null, val preload: Boolean? = null, val addPrecedence: Boolean? = null, val selectOnTab: Boolean? = null, val duplicates: Boolean? = null, val caretPosition: Boolean? = null, val checkboxOptions: Boolean? = null, val clearButtonTitle: String? = null, val dropdownHeaderTitle: String? = null, val dropdownInput: Boolean? = null, val inputAutogrow: Boolean? = null, val noActiveItems: Boolean? = null, val noBackspaceDelete: Boolean? = null, val removeButtonTitle: String? = null, val restoreOnBackspace: Boolean? = null, val options: List<dynamic>? = null)

TomSelectRemote

open class TomSelectRemote<out T : Any>(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?, String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, preload: Boolean = false, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: TomSelectRemote<T>.() -> Unit? = null) : SimplePanel, StringFormControl, MutableState<String?>

The form field component for TomSelectRemote control.

TomSelectRemoteInput

open class TomSelectRemoteInput<out T : Any>(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?, String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, preload: Boolean = false, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, className: String? = null, init: TomSelectRemoteInput<T>.() -> Unit? = null) : TomSelectInput

The TomSelectInput control connected to the fullstack service.

TomSelectRenders

data class TomSelectRenders(val option: (dynamic, escape: (String) -> String) -> String? = null, val item: (dynamic, escape: (String) -> String) -> String? = null, val optionCreate: (dynamic, escape: (String) -> String) -> String? = null, val noResults: (dynamic, escape: (String) -> String) -> String? = null, val notLoading: (dynamic, escape: (String) -> String) -> String? = null, val optGroup: (dynamic) -> String? = null, val optGroupHeader: (dynamic, escape: (String) -> String) -> String? = null, val loading: (dynamic, escape: (String) -> String) -> String? = null, val dropdown: () -> String? = null)

Functions

decodeURIComponent

external fun decodeURIComponent(encodedURI: String): String

select

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

DSL builder extension function.

selectInput

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

DSL builder extension function.

selectOptGroup

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

fun SelectInput.selectOptGroup(label: String, options: List<<Error class: unknown class><String, String>>? = 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

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

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

selectRemote

fun <T : Any> Container.~~selectRemote~~(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?, String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, preload: Boolean = false, label: String? = null, rich: Boolean = false, init: SelectRemote<T>.() -> Unit? = null): SelectRemote<T>

DSL builder extension function.

selectRemoteInput

fun <T : Any> Container.~~selectRemoteInput~~(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?, String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, preload: Boolean = false, className: String? = null, init: SelectRemoteInput<T>.() -> Unit? = null): SelectRemoteInput<T>

DSL builder extension function.

simpleSelect

fun Container.simpleSelect(options: List<<Error class: unknown class><String, String>>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, name: String? = null, label: String? = null, rich: Boolean = false, floating: Boolean = false, init: SimpleSelect.() -> Unit? = null): SimpleSelect

DSL builder extension function.

simpleSelectInput

fun Container.simpleSelectInput(options: List<<Error class: unknown class><String, String>>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, className: String? = null, init: SimpleSelectInput.() -> Unit? = null): SimpleSelectInput

DSL builder extension function.

simpleSelectRemote

fun <T : Any> Container.simpleSelectRemote(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, name: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, label: String? = null, rich: Boolean = false, init: SimpleSelectRemote<T>.() -> Unit? = null): SimpleSelectRemote<T>

DSL builder extension function.

simpleSelectRemoteInput

fun <T : Any> Container.simpleSelectRemoteInput(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, className: String? = null, init: SimpleSelectRemoteInput<T>.() -> Unit? = null): SimpleSelectRemoteInput<T>

DSL builder extension function.

toJs

fun TomSelectCallbacks.toJs(): dynamic

fun TomSelectRenders.toJs(): dynamic

fun TomSelectOptions.toJs(emptyOption: Boolean): dynamic

fun AjaxOptions.toJs(emptyOption: Boolean): dynamic

Convert AjaxOptions to JavaScript JSON object.

tomSelect

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

DSL builder extension function.

tomSelectInput

fun Container.tomSelectInput(options: List<<Error class: unknown class><String, String>>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, className: String? = null, init: TomSelectInput.() -> Unit? = null): TomSelectInput

DSL builder extension function.

tomSelectRemote

fun <T : Any> Container.tomSelectRemote(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?, String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, preload: Boolean = false, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: TomSelectRemote<T>.() -> Unit? = null): TomSelectRemote<T>

DSL builder extension function.

tomSelectRemoteInput

fun <T : Any> Container.tomSelectRemoteInput(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?, String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, preload: Boolean = false, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, className: String? = null, init: TomSelectRemoteInput<T>.() -> Unit? = null): TomSelectRemoteInput<T>

DSL builder extension function.