herald-compose/io.github.mkhytarmkhoian.herald.compose

Package-level declarations

Properties

LocalEventTrackerService

val LocalEventTrackerService: ProvidableCompositionLocal<EventTrackerService>

The EventTrackerService used by TrackScreenView, TrackOnLifecycleEvent, rememberTracker and trackImpression.

Functions

rememberTracker

@Composable

fun rememberTracker(): (Event) -> Unit

A function that tracks an event, for click handlers and other callbacks in a composable that has no ViewModel:

trackImpression

fun Modifier.trackImpression(event: Event, threshold: Float = 0.5f, minVisibleDuration: Duration = Duration.ZERO): Modifier

Tracks event once, when at least threshold of this layout is visible on screen. With a minVisibleDuration, it has to stay that visible for that long first; leaving earlier cancels the count.

TrackOnLifecycleEvent

@Composable

fun TrackOnLifecycleEvent(event: Event, on: Lifecycle.Event = Lifecycle.Event.ON_RESUME)

Tracks event every time the host lifecycle reaches on. The default, ON_RESUME, is every time the screen becomes visible; ON_PAUSE or ON_STOP is every time the user leaves it. ON_DESTROY is not supported.

TrackScreenView

@Composable

fun TrackScreenView(event: ScreenViewEvent, on: Lifecycle.Event = Lifecycle.Event.ON_RESUME)

Tracks event every time the host lifecycle reaches on.