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

constructor(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>

dataLoader

fun <T, C> Component<C>.dataLoader(load: suspend () -> Flow<T>): DataLoader<T>

doubleClickProtection

fun <T> Component<T>.doubleClickProtection(): DoubleClickProtection

focus

fun focus(cssSelector: String)

formController

fun <T> Component<T>.formController(): FormController

formObserver

fun <T> Component<T>.formObserver(): FormController

invoke

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

Subscribes to a Stream.

onMessage

inline fun <M : Message<*>> Component<*>.onMessage(noinline handler: (M) -> Unit)

Listens for a Message of the given type M.

pagedSearchFilter

fun <C> Component<C>.pagedSearchFilter(router: Router, onChange: (PagedSearchFilter) -> Unit? = null): ReadWriteProperty<Component<C>, PagedSearchFilter>

render

open override fun VDom.render()

Every component needs to implement this method

renderErrors

fun FormField.renderErrors(flow: FlowContent)

renderLabel

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

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

reset

open override fun reset()

Resets the form field.

sendMessage

fun <M : Message<*>> Component<*>.sendMessage(message: M)

Send the given message.

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.

urlParam

fun <C> Component<C>.urlParam(router: Router, name: String, default: Int, onChange: (Int) -> Unit? = null): ReadWriteProperty<Component<C>, Int>

fun <C> Component<C>.urlParam(router: Router, name: String, default: String, onChange: (String) -> Unit? = null): ReadWriteProperty<Component<C>, String>

urlParams

fun <C, T> Component<C>.urlParams(router: Router, fromParams: (Map<String, String>) -> T, toParams: (T) -> Map<String, Any?>, onChange: (T) -> Unit? = null): ReadWriteProperty<Component<C>, T>

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

messages

val Component<*>.messages: MessagesHandler

Get the MessagesHandler for the Component

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.