core/de.peekandpoke.kraft.addons.dnd/DndDragHandleComponent

DndDragHandleComponent

class DndDragHandleComponent<PAYLOAD : Any>(ctx: Ctx<DndDragHandleComponent.Props<PAYLOAD>>) : Component<DndDragHandleComponent.Props<PAYLOAD>>

Constructors

fun <PAYLOAD : Any> DndDragHandleComponent(ctx: Ctx<DndDragHandleComponent.Props<PAYLOAD>>)

Types

Props

data class Props<PAYLOAD : Any>( val payloadType: KClass<PAYLOAD>, val payload: PAYLOAD, val host: Component<*>?, val key: String?)

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 override fun onMount()

Called when the drag handle component is put into the Dom

onNextProps

open fun onNextProps(newProps: DndDragHandleComponent.Props<PAYLOAD>, previousProps: DndDragHandleComponent.Props<PAYLOAD>)

Called when the component is about to receive new props.

onUnmount

open override 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()

We need to render a dummy element, so that we can get our hands on

shouldRedraw

open fun shouldRedraw(nextProps: DndDragHandleComponent.Props<PAYLOAD>): Boolean

Returns 'true' when the component should redraw.

stream

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

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): ComponentStateProperty<T>

Creates a read write property for the components state.

Properties

attributes

val attributes: MutableTypedAttributes

The attributes of the component

ctx

val ctx: Ctx<DndDragHandleComponent.Props<PAYLOAD>>

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: DndDragHandleComponent.Props<PAYLOAD>

Public getter for the Props