components/dev.fritz2.components.toast/ToastComponentBase

ToastComponentBase

abstract class ToastComponentBase : ManagedComponent<Unit> , CloseButtonProperty

This class is the base for different types of toast-components and contains all necesserary logic except the content-related aspects. This way, different types of toasts with specific DSL variations can be implemented by inheriting from this base class and implementing the rendering logic exposed via the avstract renderContent method.

Currently, the following comppnents are part of the toast family:

ToastComponent (created via toast and showToast)
AlertToastComponent (created via alertToast and showAlertToast)

See the respective subclass's documentation for more information and concrete usage examples.

Constructors

ToastComponentBase

fun ToastComponentBase()

Types

CloseMethodCompanion

open class CloseMethodCompanion

This class defines helpful methods to either close all currently open (closeAllToasts) or the last created toast (closeLastToast) which can be called via the companion objects of both ToastComponent and AlertToastComponent.

Companion

object Companion : ToastComponentBase.CloseMethodCompanion

Placement

object Placement

ToastFragment

data class ToastFragment( val id: String, val placement: String, val render: RenderContext.() -> Li)

ToastStore

object ToastStore : RootStore<List<ToastComponentBase.ToastFragment>>

Functions

render

open override fun render( styling: BoxParams.() -> Unit, baseClass: StyleClass, id: String?, prefix: String)

This method registers one toast at the central toast store and creates a rendering expression that will be executed by the central rendering in the companion's object ToastComponentBase.Companion init block.