autograph-compose/dev.ynagai.autograph.compose

Package-level declarations

Types

data class AutocaptureConfig(val eventName: String = DEFAULT_AUTOCAPTURE_EVENT_NAME)

Enables automatic click capture when passed to AutographProvider — taps anywhere in the composition are observed and reported via dev.ynagai.autograph.Tracker.track without needing trackClick on every element. Opt-in: omit it (the default) to only report explicitly instrumented elements.

ScreenContext

data class ScreenContext(val screen: String, val section: String? = null)

The screen (and optional section) an element belongs to. Provided by TrackedScreen so that nested instrumentation — e.g. impression and click tracking — can attach screen context automatically.

Properties

LocalScreenContext

val LocalScreenContext: ProvidableCompositionLocal<ScreenContext?>

The ambient ScreenContext, or null outside of a TrackedScreen.

LocalTracker

val LocalTracker: ProvidableCompositionLocal<Tracker>

The ambient Tracker for the composition. Provide it with AutographProvider; until then, events are dropped and a single warning is printed.

Functions

autographIgnore

fun Modifier.autographIgnore(): Modifier

Marks a subtree as excluded from autocapture (see AutocaptureConfig / AutographProvider). Explicit instrumentation (trackClick/trackImpression) inside the subtree is unaffected — this only stops the ambient tap observer from reporting taps here on its own.

AutographProvider

@Composable

fun AutographProvider(tracker: Tracker, autocapture: AutocaptureConfig? = null, scopeStack: ScopeStack? = null, content: @Composable () -> Unit)

Provides tracker to the composition via LocalTracker and wires application lifecycle events (foreground/background) into the tracker's session bookkeeping.

AutographScope

@Composable

fun AutographScope(properties: JsonObject, content: @Composable () -> Unit)

AutographScope overload taking a JsonObject, for scope values that aren't strings (numbers, booleans, nested objects) or that are already assembled as a JsonObject.

@Composable

fun AutographScope(vararg properties: Pair<String, String>, content: @Composable () -> Unit)

Attaches properties to every event emitted from content — a screen-scoped context such as the article_id on an articles/{article_id} route.

trackClick

fun Modifier.trackClick(name: String, properties: JsonObject = EmptyJsonObject, target: String? = null, onClick: () -> Unit): Modifier

Fires name on click, then invokes onClick. Screen/section from the ambient ScreenContext (see TrackedScreen) are merged into properties automatically when this element is nested inside one.

TrackedScreen

@Composable

fun TrackedScreen(name: String, properties: JsonObject = EmptyJsonObject, section: String? = null, content: @Composable () -> Unit)

TrackScreenView plus ambient ScreenContext for the content — nested instrumentation inside content is attributed to this screen automatically.

trackImpression

fun Modifier.trackImpression(name: String, properties: JsonObject = EmptyJsonObject, target: String? = null, minDurationMs: Long = 500, minFractionVisible: Float = 0.5f): Modifier

Fires name the first time this element becomes visible — at least minFractionVisible of its bounds inside the viewport for at least minDurationMs — and never again for the lifetime of this composable instance, even if it later scrolls out of view and back. Built on the stable androidx.compose.ui.layout.onVisibilityChanged; that API itself re-fires on every visibility transition, so the "only once" bookkeeping happens here.

TrackScreenView

@Composable

fun TrackScreenView(name: String, properties: JsonObject = EmptyJsonObject)

Records a Screen Viewed event once when name enters the composition (and again whenever name changes). A previous_screen property is attached automatically when a previous screen is known.

TrackScreenViews

@Composable

fun NavController.TrackScreenViews(screenName: (NavDestination) -> String? = { it.route })

Automatically records a Screen Viewed event for every destination change of this NavController (androidx.navigation, a.k.a. navigation-compose).