kvision-bootstrap-select/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>>? = null, value: String? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false, init: Select.() -> Unit? = null)

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

The basic component for Select control.

SelectOptGroup

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

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)

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: unknown class>.~~select~~(options: List<<Error class: unknown 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: unknown class>.~~selectInput~~(options: List<<Error class: unknown 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: unknown 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: unknown 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.