kvision / pl.treksoft.kvision.form.text / AbstractTextInput

AbstractTextInput

(js) abstract class AbstractTextInput : Widget, FormInput, ObservableState<String?>

Base class for basic text components.

Constructors

(js)

<init>

AbstractTextInput(value: String? = null, classes: Set<String> = setOf())

Properties

(js)

autofocus

Determines if the text input is automatically focused.

var autofocus: Boolean?
(js)

disabled

Determines if the field is disabled.

open var disabled: Boolean
(js)

maxlength

Maximal length of the text input value.

var maxlength: Int?
(js)

name

The name attribute of the generated HTML input element.

open var name: String?
(js)

observers

val observers: MutableList<(String?) -> Unit>
(js)

placeholder

The placeholder for the text input.

var placeholder: String?
(js)

readonly

Determines if the text input is read-only.

var readonly: Boolean?
(js)

size

The size of the input.

open var size: InputSize?
(js)

startValue

The value attribute of the generated HTML input element.

var startValue: String?
(js)

validationStatus

The validation status of the input.

open var validationStatus: ValidationStatus?
(js)

value

Text input value.

var value: String?

Functions

(js)

afterInsert

Method called after inserting Snabbdom vnode into the DOM.

open fun afterInsert(node: VNode): Unit
(js)

blur

Makes the input element blur.

open fun blur(): Unit
(js)

focus

Makes the input element focused.

open fun focus(): Unit
(js)

getSnAttrs

Returns list of element attributes in the form of a List.

open fun getSnAttrs(): List<StringPair>
(js)

getSnClass

Returns list of CSS class names for current widget in the form of a List.

open fun getSnClass(): List<StringBoolPair>
(js)

getState

Get current state.

open fun getState(): String?
(js)

subscribe

Subscribe for the state change notifications.

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

Extension Properties

(js)

changeFlow

Extension property returning Flow for a change event.

val <T : Widget> T.changeFlow: Flow<T>
(js)

clickFlow

Extension property returning Flow for a click event.

val <T : Widget> T.clickFlow: Flow<T>
(js)

inputFlow

Extension property returning Flow for an input event.

val <T : Widget> T.inputFlow: Flow<T>
(js)

stateFlow

Extension property returning StateFlow for an ObservableState.

val <S> ObservableState<S>.stateFlow: StateFlow<S>

Extension Functions

(js)

addBsBgColor

fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit
(js)

addBsBorder

fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit
(js)

addBsClearfix

fun Component.addBsClearfix(): Unit
(js)

addBsColor

fun Component.addBsColor(bsColor: BsColor): Unit
(js)

addBsRounded

fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit
(js)

bind

An extension function which binds the widget to the observable state.

fun <S, W : Widget> W.bind(observableState: ObservableState<S>, removeChildren: Boolean = true, factory: W.(S) -> Unit): W
(js)

contextMenu

DSL builder extension function.

fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String>? = null, className: String? = null, init: (ContextMenu.() -> Unit)? = null): ContextMenu
(js)

enableGestureDetector

Enable gesture detector for a given Widget.

fun Widget.enableGestureDetector(): Unit
(js)

eventFlow

Extension property returning Flow<Pair<Widget, Event>> for a given event

fun <T : Widget> T.eventFlow(event: String): Flow<Pair<T, Event>>
(js)

onClick

An extension function for defining on click event handlers.

fun <T : Widget> T.onClick(handler: T.(MouseEvent) -> Unit): Int
(js)

onEvent

An extension function for defining event handlers.

fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Int
(js)

removeBsBgColor

fun Component.removeBsBgColor(bsBgColor: BsBgColor): Unit
(js)

removeBsBorder

fun Component.removeBsBorder(vararg bsBorder: BsBorder): Unit
(js)

removeBsClearfix

fun Component.removeBsClearfix(): Unit
(js)

removeBsColor

fun Component.removeBsColor(bsColor: BsColor): Unit
(js)

removeBsRounded

fun Component.removeBsRounded(vararg bsRounded: BsRounded): Unit
(js)

setContextMenu

Sets context menu for the current widget.

fun Widget.setContextMenu(contextMenu: ContextMenu): Widget
(js)

style

DSL builder extension function.

fun Widget.style(className: String? = null, init: (Style.() -> Unit)? = null): Style

Inheritors

(js)

RichTextInput

Basic rich text component.

open class RichTextInput : AbstractTextInput
(js)

TextAreaInput

Basic textarea component.

open class TextAreaInput : AbstractTextInput
(js)

TextInput

Basic text component.

open class TextInput : AbstractTextInput