kvision-tom-select-remote/io.kvision.form.select/TomSelectRemoteInput

TomSelectRemoteInput

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

The TomSelectInput control connected to the fullstack service.

Parameters

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

value

selected 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

preload

preload all options from remote data source

openOnFocus

open dropdown on input focus

requestFilter

a request filtering function

className

CSS class names

init

an initializer extension function

Constructors

TomSelectRemoteInput

constructor(serviceManager: KVServiceMgr<T>, function: suspend T.(String?, String?, String?) -> List<RemoteOption>, stateFunction: () -> String? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, maxOptions: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, preload: Boolean = false, openOnFocus: Boolean = false, requestFilter: suspend RequestInit.() -> Unit? = null, className: String? = null, init: TomSelectRemoteInput<T>.() -> Unit? = null)

Properties

_archivedState

var _archivedState: dynamic

alignContent

open var alignContent: AlignContent?

alignItems

open var alignItems: AlignItems?

alignSelf

open var alignSelf: AlignItems?

autofocus

var autofocus: Boolean?

background

open var background: Background?

border

open var border: Border?

borderBottom

open var borderBottom: Border?

borderLeft

open var borderLeft: Border?

borderRadius

open var borderRadius: CssSize?

borderRadiusList

open var borderRadiusList: List<CssSize>?

borderRight

open var borderRight: Border?

borderTop

open var borderTop: Border?

bottom

open var bottom: CssSize?

boxShadow

open var boxShadow: BoxShadow?

boxShadowList

open var boxShadowList: List<BoxShadow>?

clear

open var clear: Clear?

color

open var color: Color?

colorHex

open var colorHex: Int?

colorName

open var colorName: Col?

cursor

open var cursor: Cursor?

disabled

open override var disabled: Boolean

disableSearch

var disableSearch: Boolean

display

open var display: Display?

draggable

var draggable: Boolean?

emptyOption

var emptyOption: Boolean

eventTarget

var eventTarget: Widget?

flexBasis

open var flexBasis: CssSize?

flexDirection

open var flexDirection: FlexDirection?

flexGrow

open var flexGrow: Int?

flexShrink

open var flexShrink: Int?

flexWrap

open var flexWrap: FlexWrap?

float

open var float: PosFloat?

fontFamily

open var fontFamily: String?

fontSize

open var fontSize: CssSize?

fontStyle

open var fontStyle: FontStyle?

fontVariant

open var fontVariant: FontVariant?

fontWeight

open var fontWeight: FontWeight?

gridArea

open var gridArea: String?

gridAutoColumns

open var gridAutoColumns: String?

gridAutoFlow

open var gridAutoFlow: GridAutoFlow?

gridAutoRows

open var gridAutoRows: String?

gridColumnEnd

open var gridColumnEnd: String?

gridColumnGap

open var gridColumnGap: Int?

gridColumnStart

open var gridColumnStart: Int?

gridRowEnd

open var gridRowEnd: String?

gridRowGap

open var gridRowGap: Int?

gridRowStart

open var gridRowStart: Int?

gridTemplateAreas

open var gridTemplateAreas: List<String>?

gridTemplateColumns

open var gridTemplateColumns: String?

gridTemplateRows

open var gridTemplateRows: String?

height

open var height: CssSize?

var id: String?

justifyContent

open var justifyContent: JustifyContent?

justifyItems

open var justifyItems: JustifyItems?

justifySelf

open var justifySelf: JustifyItems?

kvscope

var kvscope: dynamic

left

open var left: CssSize?

letterSpacing

open var letterSpacing: CssSize?

lineBreak

open var lineBreak: LineBreak?

lineHeight

open var lineHeight: CssSize?

listStyle

open var listStyle: ListStyle?

margin

open var margin: CssSize?

marginBottom

open var marginBottom: CssSize?

marginLeft

open var marginLeft: CssSize?

marginRight

open var marginRight: CssSize?

marginTop

open var marginTop: CssSize?

maxHeight

open var maxHeight: CssSize?

maxOptions

var maxOptions: Int?

maxWidth

open var maxWidth: CssSize?

minHeight

open var minHeight: CssSize?

minWidth

open var minWidth: CssSize?

multiple

var multiple: Boolean

name

open override var name: String?

opacity

open var opacity: Double?

options

var options: List<StringPair>?

order

open var order: Int?

outline

open var outline: Outline?

overflow

open var overflow: Overflow?

overflowWrap

open var overflowWrap: OverflowWrap?

overflowX

open var overflowX: Overflow?

overflowY

open var overflowY: Overflow?

padding

open var padding: CssSize?

paddingBottom

open var paddingBottom: CssSize?

paddingLeft

open var paddingLeft: CssSize?

paddingRight

open var paddingRight: CssSize?

paddingTop

open var paddingTop: CssSize?

parent

open override var parent: Container?

placeholder

var placeholder: String?

popoverHooksActive

var popoverHooksActive: Boolean

popoverOptions

var popoverOptions: dynamic

position

open var position: Position?

resize

open var resize: Resize?

right

open var right: CssSize?

role

var role: String?

selectedLabel

val selectedLabel: String?

size

open override var size: InputSize?

tabindex

var tabindex: Int?

textAlign

open var textAlign: TextAlign?

textDecoration

open var textDecoration: TextDecoration?

textDirection

open var textDirection: Direction?

textIndent

open var textIndent: CssSize?

textOverflow

open var textOverflow: TextOverflow?

textShadow

open var textShadow: TextShadow?

textTransform

open var textTransform: TextTransform?

title

var title: String?

tomSelectJs

var tomSelectJs: TomSelectJs?

tooltipHooksActive

var tooltipHooksActive: Boolean

tooltipOptions

var tooltipOptions: dynamic

top

open var top: CssSize?

transition

open var transition: Transition?

transitionList

open var transitionList: List<Transition>?

tsCallbacks

var tsCallbacks: TomSelectCallbacks?

tsOptions

var tsOptions: TomSelectOptions?

tsRenders

var tsRenders: TomSelectRenders?

unicodeBidi

open var unicodeBidi: UnicodeBidi?

validationStatus

open override var validationStatus: ValidationStatus?

value

open override var value: String?

verticalAlign

open var verticalAlign: VerticalAlign?

visible

open override var visible: Boolean

whiteSpace

open var whiteSpace: WhiteSpace?

width

open var width: CssSize?

wordBreak

open var wordBreak: WordBreak?

wordSpacing

open var wordSpacing: CssSize?

zIndex

open var zIndex: Int?

Functions

add

open override fun add(child: Component)

open override fun add(position: Int, child: Component)

addAfterCreateHook

open override fun addAfterCreateHook(hook: (VNode) -> Unit): Boolean

addAfterDestroyHook

open override fun addAfterDestroyHook(hook: () -> Unit): Boolean

addAfterInsertHook

open override fun addAfterInsertHook(hook: (VNode) -> Unit): Boolean

addAll

open override fun addAll(children: List<Component>)

addBeforeDisposeHook

open override fun addBeforeDisposeHook(hook: () -> Unit): Boolean

addCssClass

open override fun addCssClass(css: String)

addCssStyle

open override fun addCssStyle(css: Style)

addSurroundingCssClass

open override fun addSurroundingCssClass(css: String)

addSurroundingCssStyle

open override fun addSurroundingCssStyle(css: Style)

blur

open fun blur()

clearAfterCreateHooks

open override fun clearAfterCreateHooks()

clearAfterDestroyHooks

open override fun clearAfterDestroyHooks()

clearAfterInsertHooks

open override fun clearAfterInsertHooks()

clearBeforeDisposeHooks

open override fun clearBeforeDisposeHooks()

clearDragDropData

open fun clearDragDropData()

clearOptions

open fun clearOptions()

clearParent

open override fun clearParent()

dispatchEvent

open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?

dispose

open override fun dispose()

disposeAll

open override fun disposeAll()

focus

open fun focus()

getAttribute

open override fun getAttribute(name: String): String?

getChildren

open override fun getChildren(): List<Component>

getElement

open override fun getElement(): HTMLElement?

getElementD

open override fun getElementD(): dynamic

getRoot

open override fun getRoot(): Root?

getSnStyle

open fun getSnStyle(): dynamic

getState

open override fun getState(): String?

getStyle

fun getStyle(name: String): String?

hasCssClass

open override fun hasCssClass(css: String): Boolean

hide

open fun hide()

invoke

open operator fun invoke(vararg children: Component)

refresh

open override fun refresh()

refreshState

open override fun refreshState()

remove

open override fun remove(child: Component)

removeAfterCreateHook

open override fun removeAfterCreateHook(hook: (VNode) -> Unit): Boolean

removeAfterDestroyHook

open override fun removeAfterDestroyHook(hook: () -> Unit): Boolean

removeAfterInsertHook

open override fun removeAfterInsertHook(hook: (VNode) -> Unit): Boolean

removeAll

open override fun removeAll()

removeAt

open override fun removeAt(position: Int)

removeAttribute

open override fun removeAttribute(name: String)

removeBeforeDisposeHook

open override fun removeBeforeDisposeHook(hook: () -> Unit): Boolean

removeCssClass

open override fun removeCssClass(css: String)

removeCssStyle

open override fun removeCssStyle(css: Style)

removeEventListener

open fun removeEventListener(id: Int)

removeEventListeners

open fun removeEventListeners()

removeStyle

fun removeStyle(name: String)

removeSurroundingCssClass

open override fun removeSurroundingCssClass(css: String)

removeSurroundingCssStyle

open override fun removeSurroundingCssStyle(css: Style)

renderVNode

open override fun renderVNode(): VNode

setAttribute

open override fun setAttribute(name: String, value: String)

setDragDropData

open fun setDragDropData(format: String, data: String)

setDropTarget

open fun setDropTarget(format: String, callback: (DragEvent) -> Unit)

open fun setDropTarget(formats: Set<String>?, callback: (DragEvent) -> Unit)

setDropTargetData

open fun setDropTargetData(format: String, callback: (String?) -> Unit)

setEventListener

open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int

setState

open override fun setState(state: String?)

setStyle

fun setStyle(name: String, value: String)

show

open fun show()

singleRender

open override fun <T> singleRender(block: () -> T): T

singleRenderAsync

open override fun singleRenderAsync(block: () -> Unit)

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

toggleVisible

open fun toggleVisible()

tomSelectRemote

fun <T : Any> Container.tomSelectRemote(serviceManager: KVServiceMgr<T>, function: suspend T.(String?, String?, String?) -> List<RemoteOption>, stateFunction: () -> String? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, maxOptions: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, preload: Boolean = false, openOnFocus: Boolean = false, requestFilter: suspend RequestInit.() -> 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: KVServiceMgr<T>, function: suspend T.(String?, String?, String?) -> List<RemoteOption>, stateFunction: () -> String? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, maxOptions: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, preload: Boolean = false, openOnFocus: Boolean = false, requestFilter: suspend RequestInit.() -> Unit? = null, className: String? = null, init: TomSelectRemoteInput<T>.() -> Unit? = null): TomSelectRemoteInput<T>

DSL builder extension function.

tomTypeaheadRemote

fun <T : Any> Container.tomTypeaheadRemote(serviceManager: KVServiceMgr<T>, function: suspend T.(String?, String?) -> List<String>, stateFunction: () -> String? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, requestFilter: suspend RequestInit.() -> Unit? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: TomTypeaheadRemote<T>.() -> Unit? = null): TomTypeaheadRemote<T>

DSL builder extension function.

tomTypeaheadRemoteInput

fun <T : Any> Container.tomTypeaheadRemoteInput(serviceManager: KVServiceMgr<T>, function: suspend T.(String?, String?) -> List<String>, stateFunction: () -> String? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, requestFilter: suspend RequestInit.() -> Unit? = null, className: String? = null, init: TomTypeaheadRemoteInput<T>.() -> Unit? = null): TomTypeaheadRemoteInput<T>

DSL builder extension function.

translate

open fun translate(text: String): String

open fun translate(text: String?): String?

unaryPlus

open operator fun String.unaryPlus()

useSnabbdomDistinctKey

open fun useSnabbdomDistinctKey()