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

Package io.kvision.form.select

Contains a simple select component as well as a full-featured component with support for remote (AJAX) data source.

Types

AjaxOptions

data class AjaxOptions(url: String?, preprocessData: (dynamic) -> dynamic?, beforeSend: (<ERROR CLASS>, <ERROR CLASS>) -> dynamic?, data: dynamic, httpType: HttpType, dataType: DataType, minLength: Int, cache: Boolean, clearOnEmpty: Boolean, clearOnError: Boolean, emptyRequest: Boolean, requestDelay: Int, restoreOnError: Boolean, preserveSelected: Boolean, processData: Boolean)

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>>?, value: String?, name: String?, multiple: Boolean, ajaxOptions: AjaxOptions?, label: String?, rich: Boolean, init: Select.() -> Unit?)

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>>?, value: String?, multiple: Boolean, ajaxOptions: AjaxOptions?, className: String?, init: SelectInput.() -> Unit?)

The basic component for Select control.

SelectOptGroup

open class SelectOptGroup(label: String, options: List<<ERROR CLASS>>?, maxOptions: Int?, disabled: Boolean, className: String?, init: SelectOptGroup.() -> Unit?)

The helper container for adding option groups to Select.

SelectOption

open class SelectOption(value: String?, label: String?, subtext: String?, icon: String?, divider: Boolean, disabled: Boolean, selected: Boolean, className: String?, init: SelectOption.() -> Unit?)

The helper component for adding options to Select or SelectOptGroup.

SelectWidthType

enum SelectWidthType : Enum<SelectWidthType>

Select width types. See Bootstrap Select width.

Functions

select

fun <ERROR CLASS>.select(options: List<<ERROR CLASS>>? = 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 <ERROR CLASS>.selectInput(options: List<<ERROR CLASS>>? = 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>>? = null, maxOptions: Int? = null, disabled: Boolean = false, className: String? = null, init: SelectOptGroup.() -> Unit? = null): SelectOptGroup

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

toJs

fun AjaxOptions.toJs(emptyOption: Boolean): dynamic

Convert AjaxOptions to JavaScript JSON object.