kvision / pl.treksoft.kvision.form.check / CheckInput

CheckInput

(js) abstract class CheckInput : Widget, FormInput

The basic input component rendered as HTML input type="checkbox" or input type="radio".

Constructors

(js)

<init>

CheckInput(type: CheckInputType = CheckInputType.CHECKBOX, value: Boolean = false, classes: Set<String> = setOf())

Properties

(js)

disabled

Determines if the field is disabled.

open var disabled: Boolean
(js)

extraValue

The additional String value used for the radio button group.

var extraValue: String?
(js)

name

The name attribute of the generated HTML input element.

open var name: String?
(js)

size

The size of the input.

open var size: InputSize?
(js)

startValue

The value attribute of the generated HTML input element.

var startValue: Boolean
(js)

type

The type of the generated HTML input element.

var type: CheckInputType
(js)

validationStatus

The validation status of the input.

open var validationStatus: ValidationStatus?
(js)

value

The selection state of the input.

var value: Boolean

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)

onClick

A convenient helper for easy setting onClick event handler.

open fun onClick(handler: CheckInput.(MouseEvent) -> Unit): CheckInput
(js)

render

Renders current component as a Snabbdom vnode.

open fun render(): VNode

Extension Properties

(js)

changeFlow

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

clickFlow

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

inputFlow

val <T : Widget> T.inputFlow: Flow<T>

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)

contextMenu

DSL builder extension function.

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

eventFlow

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

onEvent

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)

CheckBoxInput

The basic input component rendered as HTML input type="checkbox".

open class CheckBoxInput : CheckInput
(js)

RadioInput

The basic input component rendered as HTML input type="radio".

open class RadioInput : CheckInput