core/de.peekandpoke.kraft.addons.semanticui.forms/UiCheckBoxComponent

UiCheckBoxComponent

class UiCheckBoxComponent<T, P : UiCheckBoxComponent.Props<T>>(ctx: Ctx) : GenericFormField<T, UiCheckBoxComponent.Options<T>, P>

Constructors

UiCheckBoxComponent

fun > UiCheckBoxComponent(ctx: Ctx)

Types

Options

class Options<T> : FieldOptions.Base<T> , SemanticOptions<T> , SemanticOptions.Checkbox<T>

Props

data class Props<X>( val value: X, val onChange: (X) -> Unit, val options: UiCheckBoxComponent.Options<X>, val on: X, val off: X) : GenericFormField.Props<X, UiCheckBoxComponent.Options<X>>

Functions

createRef

fun <C : Component<*>> createRef(): ComponentRef.Tracker<C>

focus

fun focus(cssSelector: String)

invoke

operator fun <T> Stream<T>.invoke(handler: (T) -> Unit): () -> Unit

Subscribes to a Stream.

render

open override fun VDom.render()

Every component needs to implement this method

renderLabel

fun FlowContent.renderLabel(onClick: (evt: MouseEvent) -> Unit? = null)

fun FlowContent.renderLabel(focusCssSelector: String? = null)

reset

open override fun reset()

Resets the form field.

setValue

fun setValue(value: T)

shouldRedraw

open override fun shouldRedraw(nextProps: P): Boolean

Returns 'true' when the component should redraw.

stream

fun <T> stream( initial: T, config: Stream<T>.() -> Stream<T>? = null, handler: (T) -> Unit = {}): ComponentStreamProperty<T>

Creates a property that is backed by a StreamSource

subscribingTo

fun <T> subscribingTo(stream: Stream<T>, onNext: (T) -> Unit? = null): ReadOnlyProperty<Any?, T>

Creates a property that is subscribed to a stream.

touch

open override fun touch()

Marks the form field as touched.

triggerRedraw

fun triggerRedraw()

Triggers a redraw

untouch

open override fun untouch()

Marks the form field as not touched.

validate

open override fun validate(): Boolean

Validates all rules and returns true if all rules are fulfilled.

value

fun <T> value(initial: T, onChange: (T) -> Unit? = null): ComponentStateProperty<T>

Creates a read write property for the components state.

Properties

attributes

val attributes: MutableTypedAttributes

The attributes of the component

autoDomKey

val autoDomKey: String

An automatically generated unique dom key for the component instance.

ctx

val ctx: Ctx

currentValue

val currentValue: T

The effective value

dom

val dom: HTMLElement?

The Dom node to which the component is rendered

errors

open override var errors: List<String>

A list of validation errors.

hasErrors

open val hasErrors: Boolean

Returns true when the field has errors

lifecycle

val lifecycle: Component.LifeCycle

The life-cycle LifeCycle that the component exposes

options

val options: UiCheckBoxComponent.Options<T>

parent

val parent: Component<*>?

Accessor for the parent component

props

val props: P

Public getter for the Props

touched

open override var touched: Boolean

Track if the input value was modified.