kweb-core/kweb.state

Package-level declarations

Types

AdvancedComponent

interface ~~AdvancedComponent~~<in PARENT_ELEMENT_TYPE : Element, out RETURN_TYPE>

AdvancedComponents can be rendered into DOM elements by calling AdvancedComponent.render.

CloseReason

data class CloseReason(val explanation: String, val cause: Throwable? = null)

Component

interface ~~Component~~ : AdvancedComponent<Element, Unit>

Components can be rendered into DOM elements by calling Component.render.

KVal

open class KVal<T>(value: T) : AutoCloseable

A KVal is a read-only observable container for a value of type T. These are typically created by KVal.map or KVar.map, but can also be created directly.

KVar

class KVar<T>(initialValue: T) : KVal<T>

A KVar is an observable container for a value of type T. It must be initialized with initialValue, and this can then be modified by setting the KVar.value property. Listeners may be added using KVar.addListener, and these will be called whenever the value is changed.

ObservableList

class ObservableList<ITEM : Any>(initialItems: List<ITEM> = emptyList()) : MutableList<ITEM> , AutoCloseable

A list of items that can be observed for changes like add, remove, set, etc. Typically passed to renderEach.

RenderFragment

class RenderFragment(val startId: String, val endId: String)

RenderHandle

class RenderHandle<ITEM : Any>(val renderFragment: RenderFragment, val kvar: KVar<ITEM>)

RenderSpanNames

object RenderSpanNames

ReversibleFunction

abstract class ReversibleFunction<Input, Output>(val label: String)

Defines a reversible function, for use by KVar.map.

Functions

closeOnElementCreatorCleanup

fun ElementCreator<*>.closeOnElementCreatorCleanup(kv: KVal<*>)

combine

fun <A, B> Pair<KVar<A>, KVar<B>>.combine(): KVar<Pair<A, B>>

notNull

fun <O : Any> KVar<O?>.notNull(default: O? = null, invertDefault: Boolean = true): KVar<O>

Bi-directionally map a KVar with nullable type to its non-nullable equivalent.

plus

operator fun <O : Any> KVal<List<O>>.plus(other: KVal<List<O>>): KVal<List<O>>

property

inline fun <O, T> KVar<T>.property(property: KProperty1<T, O>): KVar<O>

Use reflection to create a KVar that bi-directionally maps to a mutable property of an object.

render

fun <PARENT_ELEMENT_TYPE : Element, RETURN_TYPE> ElementCreator<PARENT_ELEMENT_TYPE>.~~render~~(component: AdvancedComponent<PARENT_ELEMENT_TYPE, RETURN_TYPE>): RETURN_TYPE

Render the value of a KVar into DOM elements, and automatically re-render those elements whenever the value changes.

fun <T> ElementCreator<*>.render(value: KVal<T>, block: ElementCreator<Element>.(T) -> Unit): RenderFragment

Render the value of a KVal into DOM elements, and automatically re-render those elements whenever the value changes.

renderEach

fun <ITEM : Any, EL : Element> ElementCreator<EL>.renderEach(observableList: ObservableList<ITEM>, itemRenderer: ElementCreator<Element>.(ITEM) -> Unit)

Similar to render, but renders a list of items, and updates the DOM when the list changes.