kilua-tom-select/dev.kilua.form.select/TomSelect

TomSelect

open class TomSelect(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, maxOptions: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, name: String? = null, placeholder: String? = null, disabled: Boolean? = null, required: Boolean? = null, className: String? = null, id: String? = null, renderConfig: RenderConfig = RenderConfig.Default, withStateFlowDelegate: WithStateFlowDelegate<String?> = WithStateFlowDelegateImpl()) : Tag<HTMLSelectElement> , StringFormControl, WithStateFlow<String?> , ITomSelect

Tom Select component.

Constructors

TomSelect

constructor(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, maxOptions: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, name: String? = null, placeholder: String? = null, disabled: Boolean? = null, required: Boolean? = null, className: String? = null, id: String? = null, renderConfig: RenderConfig = RenderConfig.Default, withStateFlowDelegate: WithStateFlowDelegate<String?> = WithStateFlowDelegateImpl())

Properties

accesskey

open override var accesskey: Char?

alignContent

open override var alignContent: AlignContent?

alignItems

open override var alignItems: AlignItems?

alignSelf

open override var alignSelf: AlignItems?

ariaDescribedby

open override var ariaDescribedby: String?

ariaLabel

open override var ariaLabel: String?

ariaLabelledby

open override var ariaLabelledby: String?

autofocus

open override var autofocus: Boolean?

background

open override var background: Background?

border

open override var border: Border?

borderBottom

open override var borderBottom: Border?

borderLeft

open override var borderLeft: Border?

borderRadius

open override var borderRadius: CssSize?

borderRadiusList

open override var borderRadiusList: List<CssSize>?

borderRight

open override var borderRight: Border?

borderTop

open override var borderTop: Border?

bottom

open override var bottom: CssSize?

boxShadow

open override var boxShadow: BoxShadow?

boxShadowList

open override var boxShadowList: List<BoxShadow>?

children

open override val children: MutableList<ComponentBase>

className

open override var className: String?

clear

open override var clear: Clear?

color

open override var color: Color?

columnGap

open override var columnGap: CssSize?

componentId

open override val componentId: Int

cursor

open override var cursor: Cursor?

customValidity

open override var customValidity: String?

direction

open override var direction: Direction?

disabled

open override var disabled: Boolean?

Whether the select is disabled.

disableSearch

open override var disableSearch: Boolean

Disable searching in options.

display

open override var display: Display?

draggable

open override var draggable: Boolean?

element

open override val element: HTMLSelectElement

emptyOption

open override var emptyOption: Boolean

Determines if an empty option is allowed.

flexBasis

open override var flexBasis: CssSize?

flexDirection

open override var flexDirection: FlexDirection?

flexGrow

open override var flexGrow: Int?

flexShrink

open override var flexShrink: Int?

flexWrap

open override var flexWrap: FlexWrap?

float

open override var float: CssFloat?

fontFamily

open override var fontFamily: String?

fontSize

open override var fontSize: CssSize?

fontStyle

open override var fontStyle: FontStyle?

fontVariant

open override var fontVariant: FontVariant?

fontWeight

open override var fontWeight: FontWeight?

gridArea

open override var gridArea: String?

gridAutoColumns

open override var gridAutoColumns: String?

gridAutoFlow

open override var gridAutoFlow: GridAutoFlow?

gridAutoRows

open override var gridAutoRows: String?

gridColumnEnd

open override var gridColumnEnd: String?

gridColumnStart

open override var gridColumnStart: Int?

gridRowEnd

open override var gridRowEnd: String?

gridRowStart

open override var gridRowStart: Int?

gridTemplateAreas

open override var gridTemplateAreas: List<String>?

gridTemplateColumns

open override var gridTemplateColumns: String?

gridTemplateRows

open override var gridTemplateRows: String?

height

open override var height: CssSize?

open override var id: String?

innerHTML

open val innerHTML: String

justifyContent

open override var justifyContent: JustifyContent?

justifyItems

open override var justifyItems: JustifyItems?

justifySelf

open override var justifySelf: JustifyItems?

left

open override var left: CssSize?

letterSpacing

open override var letterSpacing: CssSize?

lineBreak

open override var lineBreak: LineBreak?

lineHeight

open override var lineHeight: CssSize?

listStyle

open override var listStyle: ListStyle?

margin

open override var margin: CssSize?

marginBottom

open override var marginBottom: CssSize?

marginLeft

open override var marginLeft: CssSize?

marginRight

open override var marginRight: CssSize?

marginTop

open override var marginTop: CssSize?

maxHeight

open override var maxHeight: CssSize?

maxOptions

open override var maxOptions: Int?

The maximum number of visible options.

maxWidth

open override var maxWidth: CssSize?

minHeight

open override var minHeight: CssSize?

minWidth

open override var minWidth: CssSize?

multiple

open override var multiple: Boolean

Determines if multiple value selection is allowed.

mutableStateFlow

open override val mutableStateFlow: MutableStateFlow<String?>

name

open override var name: String?

The name of the select.

node

val node: Node

opacity

open override var opacity: Double?

options

open override var options: List<StringPair>?

The list of options (value to label pairs).

order

open override var order: Int?

outline

open override var outline: Outline?

overflow

open override var overflow: Overflow?

overflowWrap

open override var overflowWrap: OverflowWrap?

overflowX

open override var overflowX: Overflow?

overflowY

open override var overflowY: Overflow?

padding

open override var padding: CssSize?

paddingBottom

open override var paddingBottom: CssSize?

paddingLeft

open override var paddingLeft: CssSize?

paddingRight

open override var paddingRight: CssSize?

paddingTop

open override var paddingTop: CssSize?

parent

open override var parent: Component?

placeholder

open override var placeholder: String?

The placeholder for the select component.

position

open override var position: Position?

renderConfig

open override val renderConfig: RenderConfig

required

open override var required: Boolean?

resize

open override var resize: Resize?

right

open override var right: CssSize?

role

open override var role: String?

rowGap

open override var rowGap: CssSize?

selectedLabel

open override val selectedLabel: String?

The label of the currently selected option.

stateFlow

open override val stateFlow: StateFlow<String?>

tabindex

open override var tabindex: Int?

textAlign

open override var textAlign: TextAlign?

textContent

open var textContent: String?

textDecoration

open override var textDecoration: TextDecoration?

textIndent

open override var textIndent: CssSize?

textOverflow

open override var textOverflow: TextOverflow?

textShadow

open override var textShadow: TextShadow?

textTransform

open override var textTransform: TextTransform?

title

open override var title: String?

tomSelectInstance

open override var tomSelectInstance: TomSelectJs?

Tom Select native component instance.

top

open override var top: CssSize?

transition

open override var transition: Transition?

transitionList

open override var transitionList: List<Transition>?

tsCallbacks

open override var tsCallbacks: TomSelectCallbacks?

Tom Select callbacks.

tsOptions

open override var tsOptions: TomSelectOptions?

Tom Select options.

tsRenders

open override var tsRenders: TomSelectRenders?

Tom Select renders.

unicodeBidi

open override var unicodeBidi: UnicodeBidi?

value

open override var value: String?

verticalAlign

open override var verticalAlign: VerticalAlign?

visible

open override var visible: Boolean

whiteSpace

open override var whiteSpace: WhiteSpace?

width

open override var width: CssSize?

wordBreak

open override var wordBreak: WordBreak?

wordSpacing

open override var wordSpacing: CssSize?

zIndex

open override var zIndex: Int?

Functions

accesskey

open override fun accesskey(accesskey: Char?)

alignContent

open override fun alignContent(alignContent: AlignContent?)

alignItems

open override fun alignItems(alignItems: AlignItems?)

alignSelf

open override fun alignSelf(alignSelf: AlignItems?)

ariaDescribedby

open override fun ariaDescribedby(ariaDescribedby: String?)

ariaLabel

open override fun ariaLabel(ariaLabel: String?)

ariaLabelledby

open override fun ariaLabelledby(ariaLabelledby: String?)

attribute

open override fun attribute(name: String, value: String?)

autofocus

open override fun autofocus(autofocus: Boolean?)

background

open override fun background(background: Background?)

blur

open override fun blur()

border

open override fun border(border: Border?)

borderBottom

open override fun borderBottom(borderBottom: Border?)

borderLeft

open override fun borderLeft(borderLeft: Border?)

borderRadius

open override fun borderRadius(borderRadius: CssSize?)

borderRadiusList

open override fun borderRadiusList(borderRadiusList: List<CssSize>?)

borderRight

open override fun borderRight(borderRight: Border?)

borderTop

open override fun borderTop(borderTop: Border?)

bottom

open override fun bottom(bottom: CssSize?)

boxShadow

open override fun boxShadow(boxShadow: BoxShadow?)

boxShadowList

open override fun boxShadowList(boxShadowList: List<BoxShadow>?)

className

open override fun className(className: String?)

clear

open override fun clear(clear: Clear?)

clearDragDropData

open override fun clearDragDropData()

clearDropTarget

open override fun clearDropTarget()

clearOptions

open override fun clearOptions()

Removes all unselected options from the control.

color

open override fun color(color: Color?)

columnGap

open override fun columnGap(columnGap: CssSize?)

cursor

open override fun cursor(cursor: Cursor?)

direction

open override fun direction(direction: Direction?)

disabled

@Composable

open override fun disabled(disabled: Boolean?)

Set whether the select is disabled.

disableSearch

@Composable

open override fun disableSearch(disableSearch: Boolean)

Set whether searching in options is disabled.

dispatchEvent

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

display

open override fun display(display: Display?)

draggable

open override fun draggable(draggable: Boolean?)

emptyOption

@Composable

open override fun emptyOption(emptyOption: Boolean)

Set whether an empty option is allowed.

flexBasis

open override fun flexBasis(flexBasis: CssSize?)

flexDirection

open override fun flexDirection(flexDirection: FlexDirection?)

flexGrow

open override fun flexGrow(flexGrow: Int?)

flexShrink

open override fun flexShrink(flexShrink: Int?)

flexWrap

open override fun flexWrap(flexWrap: FlexWrap?)

float

open override fun float(float: CssFloat?)

focus

open override fun focus()

fontFamily

open override fun fontFamily(fontFamily: String?)

fontSize

open override fun fontSize(fontSize: CssSize?)

fontStyle

open override fun fontStyle(fontStyle: FontStyle?)

fontVariant

open override fun fontVariant(fontVariant: FontVariant?)

fontWeight

open override fun fontWeight(fontWeight: FontWeight?)

getAttribute

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

getStyle

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

getValue

open fun getValue(): Any?

getValueAsString

open override fun getValueAsString(): String?

gridArea

open override fun gridArea(gridArea: String?)

gridAutoColumns

open override fun gridAutoColumns(gridAutoColumns: String?)

gridAutoFlow

open override fun gridAutoFlow(gridAutoFlow: GridAutoFlow?)

gridAutoRows

open override fun gridAutoRows(gridAutoRows: String?)

gridColumnEnd

open override fun gridColumnEnd(gridColumnEnd: String?)

gridColumnStart

open override fun gridColumnStart(gridColumnStart: Int?)

gridRowEnd

open override fun gridRowEnd(gridRowEnd: String?)

gridRowStart

open override fun gridRowStart(gridRowStart: Int?)

gridTemplateAreas

open override fun gridTemplateAreas(gridTemplateAreas: List<String>?)

gridTemplateColumns

open override fun gridTemplateColumns(gridTemplateColumns: String?)

gridTemplateRows

open override fun gridTemplateRows(gridTemplateRows: String?)

height

open override fun height(height: CssSize?)

hide

open fun hide()

open override fun id(id: String?)

justifyContent

open override fun justifyContent(justifyContent: JustifyContent?)

justifyItems

open override fun justifyItems(justifyItems: JustifyItems?)

justifySelf

open override fun justifySelf(justifySelf: JustifyItems?)

left

open override fun left(left: CssSize?)

letterSpacing

open override fun letterSpacing(letterSpacing: CssSize?)

lineBreak

open override fun lineBreak(lineBreak: LineBreak?)

lineHeight

open override fun lineHeight(lineHeight: CssSize?)

listStyle

open override fun listStyle(listStyle: ListStyle?)

margin

open override fun margin(margin: CssSize?)

marginBottom

open override fun marginBottom(marginBottom: CssSize?)

marginLeft

open override fun marginLeft(marginLeft: CssSize?)

marginRight

open override fun marginRight(marginRight: CssSize?)

marginTop

open override fun marginTop(marginTop: CssSize?)

maxHeight

open override fun maxHeight(maxHeight: CssSize?)

maxOptions

@Composable

open override fun maxOptions(maxOptions: Int?)

Set the maximum number of visible options.

maxWidth

open override fun maxWidth(maxWidth: CssSize?)

minHeight

open override fun minHeight(minHeight: CssSize?)

minWidth

open override fun minWidth(minWidth: CssSize?)

multiple

@Composable

open override fun multiple(multiple: Boolean)

Set whether multiple value selection is allowed.

name

@Composable

open override fun name(name: String?)

Set the name of the select.

onBlur

open override fun onBlur(listener: (FocusEvent) -> Unit): Int

onBlurDirect

open override fun onBlurDirect(listener: (FocusEvent) -> Unit): Int

onChange

open override fun onChange(listener: (Event) -> Unit): Int

onChangeDirect

open override fun onChangeDirect(listener: (Event) -> Unit): Int

onClick

open override fun onClick(listener: (MouseEvent) -> Unit): Int

onClickDirect

open override fun onClickDirect(listener: (MouseEvent) -> Unit): Int

onContextmenu

open override fun onContextmenu(listener: (MouseEvent) -> Unit): Int

onContextmenuDirect

open override fun onContextmenuDirect(listener: (MouseEvent) -> Unit): Int

onDblclick

open override fun onDblclick(listener: (MouseEvent) -> Unit): Int

onDblclickDirect

open override fun onDblclickDirect(listener: (MouseEvent) -> Unit): Int

onEvent

open override fun <EV : Event> onEvent(name: String, listener: (EV) -> Unit): Int

onEventDirect

open override fun <EV : Event> onEventDirect(name: String, listener: (EV) -> Unit): Int

onFocus

open override fun onFocus(listener: (FocusEvent) -> Unit): Int

onFocusDirect

open override fun onFocusDirect(listener: (FocusEvent) -> Unit): Int

onInput

open override fun onInput(listener: (InputEvent) -> Unit): Int

onInputDirect

open override fun onInputDirect(listener: (InputEvent) -> Unit): Int

onInsert

open override fun onInsert()

onKeydown

open override fun onKeydown(listener: (KeyboardEvent) -> Unit): Int

onKeydownDirect

open override fun onKeydownDirect(listener: (KeyboardEvent) -> Unit): Int

onKeypress

open override fun onKeypress(listener: (KeyboardEvent) -> Unit): Int

onKeypressDirect

open override fun onKeypressDirect(listener: (KeyboardEvent) -> Unit): Int

onKeyup

open override fun onKeyup(listener: (KeyboardEvent) -> Unit): Int

onKeyupDirect

open override fun onKeyupDirect(listener: (KeyboardEvent) -> Unit): Int

onRemove

open override fun onRemove()

opacity

open override fun opacity(opacity: Double?)

options

@Composable

open override fun options(options: List<StringPair>?)

Set the list of options (value to label pairs).

order

open override fun order(order: Int?)

outline

open override fun outline(outline: Outline?)

overflow

open override fun overflow(overflow: Overflow?)

overflowWrap

open override fun overflowWrap(overflowWrap: OverflowWrap?)

overflowX

open override fun overflowX(overflowX: Overflow?)

overflowY

open override fun overflowY(overflowY: Overflow?)

padding

open override fun padding(padding: CssSize?)

paddingBottom

open override fun paddingBottom(paddingBottom: CssSize?)

paddingLeft

open override fun paddingLeft(paddingLeft: CssSize?)

paddingRight

open override fun paddingRight(paddingRight: CssSize?)

paddingTop

open override fun paddingTop(paddingTop: CssSize?)

placeholder

@Composable

open override fun placeholder(placeholder: String?)

Set the placeholder for the select component.

position

open override fun position(position: Position?)

removeAttribute

open override fun removeAttribute(name: String)

removeEventListener

open override fun removeEventListener(name: String, id: Int?)

removeStyle

open override fun removeStyle(name: String)

renderToString

open fun renderToString(): String

renderToStringBuilder

open override fun renderToStringBuilder(builder: StringBuilder)

required

@Composable

open override fun required(required: Boolean?)

Set whether the select is required.

resize

open override fun resize(resize: Resize?)

right

open override fun right(right: CssSize?)

role

open override fun role(role: String?)

rowGap

open override fun rowGap(rowGap: CssSize?)

setAttribute

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

setDragDropData

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

setDropTarget

open override fun setDropTarget(callback: (DragEvent) -> Unit)

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

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

setDropTargetData

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

setStyle

open override fun setStyle(name: String, value: String?)

setValue

open fun setValue(value: Any?)

show

open fun show()

style

open override fun style(name: String, value: String?)

tabindex

open override fun tabindex(tabindex: Int?)

textAlign

open override fun textAlign(textAlign: TextAlign?)

textDecoration

open override fun textDecoration(textDecoration: TextDecoration?)

textIndent

open override fun textIndent(textIndent: CssSize?)

textOverflow

open override fun textOverflow(textOverflow: TextOverflow?)

textShadow

open override fun textShadow(textShadow: TextShadow?)

textTransform

open override fun textTransform(textTransform: TextTransform?)

title

open override fun title(title: String?)

toggle

open fun toggle()

tomSelect

@Composable

fun IComponent.tomSelect(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, maxOptions: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, name: String? = null, placeholder: String? = null, disabled: Boolean? = null, required: Boolean? = null, className: String? = null, id: String? = null, setup: @Composable ITomSelect.() -> Unit = {})

Creates TomSelect component.

tomSelectRef

@Composable

fun IComponent.tomSelectRef(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, maxOptions: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, name: String? = null, placeholder: String? = null, disabled: Boolean? = null, required: Boolean? = null, className: String? = null, id: String? = null, setup: @Composable ITomSelect.() -> Unit = {}): TomSelect

Creates TomSelect component, returning a reference.

tomTypeahead

@Composable

fun IComponent.tomTypeahead(options: List<String>? = null, value: String? = null, type: InputType = InputType.Text, tsCallbacks: TomSelectCallbacks? = null, name: String? = null, placeholder: String? = null, disabled: Boolean? = null, required: Boolean? = null, className: String? = null, id: String? = null, setup: @Composable ITomTypeahead.() -> Unit = {})

Creates TomTypeahead component.

tomTypeaheadRef

@Composable

fun IComponent.tomTypeaheadRef(options: List<String>? = null, value: String? = null, type: InputType = InputType.Text, tsCallbacks: TomSelectCallbacks? = null, name: String? = null, placeholder: String? = null, disabled: Boolean? = null, required: Boolean? = null, className: String? = null, id: String? = null, setup: @Composable ITomTypeahead.() -> Unit = {}): TomTypeahead

Creates TomTypeahead component, returning a reference.

top