core/de.peekandpoke.kraft.addons.routing/RouterComponent

RouterComponent

class RouterComponent : Component<RouterComponent.Props>

Types

Props

data class Props(val router: Router)

Functions

createRef

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

invoke

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

Subscribes to a Stream.

onMount

open fun onMount()

Called when the component is mounted

onNextProps

open fun onNextProps(newProps: RouterComponent.Props, previousProps: RouterComponent.Props)

Called when the component is about to receive new props.

onUnmount

open 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

shouldRedraw

open fun shouldRedraw(nextProps: RouterComponent.Props): 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.

triggerRedraw

fun triggerRedraw()

Triggers a redraw

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<RouterComponent.Props>

dom

val dom: HTMLElement?

The Dom node to which the component is rendered

parent

val parent: Component<*>?

Accessor for the parent component

props

val props: RouterComponent.Props

Public getter for the Props