UiInputFieldComponent

Constructors

Link copied to clipboard
fun <P : UiInputFieldComponent.Props<T>> UiInputFieldComponent(ctx: Ctx<P>)

Types

Link copied to clipboard
class Options<T> : FieldOptions.Base<T> , SemanticOptions<T> , SemanticOptions.Input<T>
Link copied to clipboard
data class Props<X>(    val value: X,     val onChange: (X) -> Unit,     val options: UiInputFieldComponent.Options<X>,     val toStr: (X) -> String,     val fromStr: (String) -> X) : GenericFormField.Props<X, UiInputFieldComponent.Options<X>>

Functions

Link copied to clipboard
fun INPUT.applyAll()
Link copied to clipboard
fun <C : Component<*>> createRef(): ComponentRef.Tracker<C>
Link copied to clipboard
fun focus(cssSelector: String)
Link copied to clipboard
operator fun <T> Stream<T>.invoke(handler: (T) -> Unit): () -> Unit

Subscribes to a Stream.

Link copied to clipboard
open override fun VDom.render()

Every component needs to implement this method

Link copied to clipboard
fun FlowContent.renderLabel(onClick: (evt: MouseEvent) -> Unit? = null)
fun FlowContent.renderLabel(focusCssSelector: String? = null)
Link copied to clipboard
open override fun reset()

Resets the form field.

Link copied to clipboard
fun setInput(input: String)
Link copied to clipboard
fun setValue(value: T)
Link copied to clipboard
open fun shouldRedraw(nextProps: P): Boolean

Returns 'true' when the component should redraw.

Link copied to clipboard
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

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

Creates a property that is subscribed to a stream.

Link copied to clipboard
open override fun touch()

Marks the form field as touched.

Link copied to clipboard
fun triggerRedraw()

Triggers a redraw

Link copied to clipboard
open override fun untouch()

Marks the form field as not touched.

Link copied to clipboard
open override fun validate(): Boolean

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

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

Creates a read write property for the components state.

Properties

Link copied to clipboard
val attributes: MutableTypedAttributes

The attributes of the component

Link copied to clipboard
val autoDomKey: String

An automatically generated unique dom key for the component instance.

Link copied to clipboard
val ctx: Ctx<P>
Link copied to clipboard
val currentValue: T

The effective value

Link copied to clipboard
val dom: HTMLElement?

The Dom node to which the component is rendered

Link copied to clipboard
open override var errors: List<String>

A list of validation errors.

Link copied to clipboard
open val hasErrors: Boolean

Returns true when the field has errors

Link copied to clipboard
val lifecycle: Component.LifeCycle<P>

The life-cycle LifeCycle that the component exposes

Link copied to clipboard
val options: UiInputFieldComponent.Options<T>
Link copied to clipboard
val parent: Component<*>?

Accessor for the parent component

Link copied to clipboard
val props: P

Public getter for the Props

Link copied to clipboard
open override var touched: Boolean

Track if the input value was modified.