kvision-bootstrap-select-remote/io.kvision.form.select/SelectRemote

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: <Error class: unknown class>? = null, preload: Boolean = false, label: String? = null, rich: Boolean = false, init: SelectRemote<T>.() -> Unit? = null)

Deprecated

Use TomSelectRemote instead from the kvision-tom-select-remote 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 SelectRemote control.

Parameters

value

selected value

serviceManager

fullstack service manager

function

fullstack service method returning the list of options

stateFunction

a function to generate the state object passed with the remote request

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 data source

preload

preload all options from remote data source

label

label text bound to the input element

rich

determines if label can contain HTML code

init

an initializer extension function

Constructors

fun <out T : Any> 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: <Error class: unknown class>? = null, preload: Boolean = false, label: String? = null, rich: Boolean = false, init: SelectRemote<T>.() -> Unit? = null)

Types

object Companion

Functions

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

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

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

open fun blur()

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

open fun disposeAll(): SelectRemote<T>

open fun focus()

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

open fun getState(): String?

open fun hideOptions()

Hides dropdown with options.

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

open fun removeAll(): SelectRemote<T>

open fun removeAt(position: Int): SelectRemote<T>

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

open fun setState(state: String?)

open fun showOptions()

Opens dropdown with options.

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

open fun toggleOptions()

Toggles visibility of dropdown with options.

Properties

var autofocus: <Error class: unknown class>

Determines if the select is automatically focused.

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.

var dropdownSize: <Error class: unknown class>

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

var emptyOption: <Error class: unknown class>

Determines if an empty option is automatically generated.

val flabel: <Error class: unknown class>

val input: SelectRemoteInput<T>

invalidFeedback

val invalidFeedback: <Error class: unknown class>

var label: <Error class: unknown class>

The label text bound to the select element.

var maxOptions: <Error class: unknown class>

Maximal number of selected options.

var multiple: <Error class: unknown class>

Determines if multiple value selection is allowed.

var placeholder: <Error class: unknown class>

The placeholder for the select control.

var rich: <Error class: unknown class>

Determines if label can contain HTML code.

var selectWidth: <Error class: unknown class>

The width of the select control.

selectWidthType

var selectWidthType: <Error class: unknown class>

The width type of the select control.

var style: <Error class: unknown class>

The style of the select control.

open var value: <Error class: unknown class>

A value of the selected option.