kvision / pl.treksoft.kvision.form.check / CheckBoxInput

CheckBoxInput

open class CheckBoxInput : CheckInput

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

Constructors

<init>

CheckBoxInput(value: Boolean = false, classes: Set<String> = setOf())

Inherited Properties

disabled

open var disabled: Boolean

Determines if the field is disabled.

extraValue

var extraValue: String?

The additional String value used for the radio button group.

name

open var name: String?

The name attribute of the generated HTML input element.

size

open var size: InputSize?

The size of the input.

startValue

var startValue: Boolean

The value attribute of the generated HTML input element.

type

var type: CheckInputType

The type of the generated HTML input element.

validationStatus

open var validationStatus: ValidationStatus?

The validation status of the input.

value

var value: Boolean

The selection state of the input.

Inherited Functions

afterInsert

open fun afterInsert(node: VNode): Unit

Method called after inserting Snabbdom vnode into the DOM.

blur

open fun blur(): Unit

Makes the input element blur.

focus

open fun focus(): Unit

Makes the input element focused.

getSnAttrs

open fun getSnAttrs(): List<StringPair>

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

getSnClass

open fun getSnClass(): List<StringBoolPair>

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

onClick

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

A convenient helper for easy setting onClick event handler.

render

open fun render(): VNode

Renders current component as a Snabbdom vnode.

Extension Properties

changeFlow

val <T : Widget> T.changeFlow: <ERROR CLASS><T>

clickFlow

val <T : Widget> T.clickFlow: <ERROR CLASS><T>

inputFlow

val <T : Widget> T.inputFlow: <ERROR CLASS><T>

Extension Functions

addBsBgColor

fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit

addBsBorder

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

addBsClearfix

fun Component.addBsClearfix(): Unit

addBsColor

fun Component.addBsColor(bsColor: BsColor): Unit

addBsRounded

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

contextMenu

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

DSL builder extension function.

createInstance

fun <T> Any?.createInstance(vararg args: dynamic): T

Helper function for creating JavaScript objects from dynamic constructors.

eventFlow

fun <T : Widget> T.eventFlow(event: String): <ERROR CLASS><Pair<T, Event>>

onEvent

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

removeBsBgColor

fun Component.removeBsBgColor(bsBgColor: BsBgColor): Unit

removeBsBorder

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

removeBsClearfix

fun Component.removeBsClearfix(): Unit

removeBsColor

fun Component.removeBsColor(bsColor: BsColor): Unit

removeBsRounded

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

setContextMenu

fun Widget.setContextMenu(contextMenu: ContextMenu): Widget

Sets context menu for the current widget.

style

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

DSL builder extension function.