headless/dev.fritz2.headless.components/Modal

Modal

This class provides the building blocks to implement a modal.

Use modal functions to create an instance, set up the needed Hooks or Propertys and refine the component by using the further factory methods offered by this class.

For more information refer to the official documentation

Constructors

Modal

constructor(id: String?)

Types

ModalPanel

inner class ModalPanel<C : HTMLElement>(tag: Tag<C>, explicitId: String? = null) : Tag<C>

Properties

val close: SimpleHandler<Unit>

componentId

val componentId: String

job

open override val job: Job

open

val open: SimpleHandler<Unit>

opened

val opened: Flow<Boolean>

openState

val openState: DatabindingProperty<Boolean>

restoreFocus

var restoreFocus: Boolean

setInitialFocus

var setInitialFocus: InitialFocus

toggle

val toggle: SimpleHandler<Unit>

Functions

errorHandler

open fun errorHandler(cause: Throwable)

handledBy

open infix fun <A> Flow<A>.handledBy(handler: Handler<A>)

open infix fun <A> Flow<A>.handledBy(execute: suspend (A) -> Unit): Job

open infix fun <E : Event> Flow<E>.handledBy(handler: Handler<Unit>)

open infix fun <E : Event> Flow<E>.handledBy(execute: suspend (E) -> Unit): Job

init

fun init()

modalPanel

fun Modal.modalPanel(classes: String? = null, id: String? = null, internalScope: ScopeContext.() -> Unit = {}, initialize: Modal.ModalPanel<HTMLDivElement>.() -> Unit)

Factory function to create a modalPanel with a HTMLDivElement as default Tag.

fun <C : HTMLElement> Modal.modalPanel(classes: String? = null, id: String? = null, internalScope: ScopeContext.() -> Unit = {}, tag: TagFactory<Tag<C>>, initialize: Modal.ModalPanel<C>.() -> Unit)

Factory function to create a modalPanel.