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

UiCheckBoxComponent

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

Constructors

UiCheckBoxComponent

fun <P : UiCheckBoxComponent.Props<T>> UiCheckBoxComponent(ctx: Ctx<P>)

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.

onMount

open override fun onMount()

Called when the component is mounted

onNextProps

open fun onNextProps(newProps: P, previousProps: P)

Called when the component is about to receive new props.

onUnmount

open override fun onUnmount()

Called when the component was removed from the dom

onUpdate

open fun onUpdate()

Called when the dom was updated. This is called after the render cycle.

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)

setValue

fun setValue(value: T)

shouldRedraw

open 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 = {}): ObservableStreamProperty<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): ObservableComponentProperty<T>

Creates a read write property for the components state.

Properties

attributes

val attributes: MutableTypedAttributes

The attributes of the component

ctx

val ctx: Ctx<P>

currentValue

val currentValue: T

dom

val dom: HTMLElement?

The Dom node to which the component is rendered

errors

open override var errors: List<String>

The errors the field currently has

hasErrors

open val hasErrors: Boolean

Returns true when the field has errors

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

Marker if the component was touched.