compose-html-ext/com.varabyte.kobweb.compose.dom

Package-level declarations

Types

ElementRefScope

data class ElementRefScope<in TElement : Element>

A callback scope for listeners that inform the user about events associated with an underlying raw DOM element.

GenericElementBuilder

class GenericElementBuilder : ElementBuilder<Element>

A useful ElementBuilder for when you don't care about its specific type.

GenericNamespacedElementBuilder

class GenericNamespacedElementBuilder : ElementBuilder<Element>

A useful ElementBuilder for elements that need to use the createElementNS method for creation.

Functions

disposableRef

fun <TElement : Element> disposableRef(vararg keys: Any?, effect: DisposableEffectScope.(TElement) -> DisposableEffectResult): ElementRefScope<TElement>

Create a ref listener which informs you both when a raw element is added to the DOM tree and when it is removed.

GenericTag

@Composable

fun GenericTag(name: String, attrsStr: String? = null, content: @Composable ElementScope<Element>.() -> Unit? = null)

A way to easily specify a generic tag and optional attributes.

@Composable

fun <E : Element> GenericTag(name: String, namespace: String? = null, attrs: AttrBuilderContext<E>? = null, content: @Composable ElementScope<E>.() -> Unit? = null)

Like the other GenericTag but allows richer typing as well as namespaced elements.

RawHtml

@Composable

fun RawHtml(htmlString: String)

Generate Compose nodes for general HTML input text.

ref

fun <TElement : Element> ref(vararg keys: Any?, handle: (TElement) -> Unit): ElementRefScope<TElement>

Create a trivial ref listener where you're informed about when a raw element is added to the DOM tree.

refScope

fun <TElement : Element> refScope(init: ElementRefScope.Builder<TElement>.() -> Unit): ElementRefScope<TElement>

Create a scope which lets you specify any number of ref and disposableRef handlers.

registerRefScope

@Composable

fun <TElement : Element> ElementScope<TElement>.registerRefScope(scope: ElementRefScope<TElement>?)

Convenience method for installing an ElementRefScope into an ElementScope.

@Composable

fun <TElementSrc : Element, TElementDst : Element> ElementScope<TElementSrc>.registerRefScope(scope: ElementRefScope<TElementDst>?, transform: (TElementSrc) -> TElementDst)

A more flexible version of registerRefScope which allows you to transform the element type of the scope.