compose/io.buszi.boomerang.compose/CatchEventBoomerangLifecycleEffect

CatchEventBoomerangLifecycleEffect

@Composable
inline fun CatchEventBoomerangLifecycleEffect(key: String, lifecycleEvent: Lifecycle.Event = Lifecycle.Event.ON_START, crossinline onEvent: () -> Unit)(source)

A specialized Composable effect for catching event notifications from the BoomerangStore. This is a convenience function that simplifies catching events in Compose UI.

Unlike the more general CatchBoomerangLifecycleEffect, this function is specifically designed for handling simple event notifications without additional data. Example usage

Parameters

key

The event key to catch

lifecycleEvent

The lifecycle event that triggers the catch attempt (default is ON_START)

onEvent

Callback function to execute when the event is caught

Throws

if the lifecycleEvent is not ON_START or ON_RESUME