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.

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.

Companion Object Functions

checkBoxInput

fun Container.checkBoxInput(value: Boolean = false, classes: Set<String> = setOf(), init: (CheckInput.() -> Unit)? = null): CheckBoxInput

DSL builder extension function.

Extension Functions

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.