core/de.peekandpoke.kraft.components/Component

Component

abstract class Component<PROPS>(val ctx: Ctx<PROPS>)

Base class of all Components

Constructors

fun <PROPS> Component(ctx: Ctx<PROPS>)

Functions

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

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

Subscribes to a Stream.

open fun onMount()

Called when the component is mounted

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

Called when the component is about to receive new props.

open fun onUnmount()

Called when the component was removed from the dom

open fun onUpdate()

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

abstract fun VDom.render()

Every component needs to implement this method

open fun shouldRedraw(nextProps: PROPS): Boolean

Returns 'true' when the component should redraw.

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

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

Creates a property that is subscribed to a stream.

fun triggerRedraw()

Triggers a redraw

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

Creates a read write property for the components state.

Properties

val attributes: MutableTypedAttributes

The attributes of the component

val ctx: Ctx<PROPS>

val dom: HTMLElement?

The Dom node to which the component is rendered

val parent: Component<*>?

Accessor for the parent component

val props: PROPS

Public getter for the Props

Inheritors

DndDragHandleComponent

DndDropTargetComponent

FormFieldComponent

GenericFormField

ListFieldComponent

RouterComponent

CollapsableComponent

ElementsPerPage

Extensions

fun Component<*>.formController(): FormController

val Component<*>.messages: MessagesHandler

Get the MessagesHandler for the Component

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>

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

Send the given message.

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>

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>