React Tracker API Reference

High level overview of all the APIs available in the React Tracker.

Tracked Elements

These Components simplify the usage of TrackedContexts. They may omit the Component property or make it optional.

Tracked Contexts

These Components wrap their children in a LocationWrapper and automatically trigger Events. Some of them may also infer attributes, such as Pressable and Link identifiers.

Location Wrappers

These Components wrap their children in a Context.Provider. This allows the ReactTracker to reconstruct their Location in the UI.

tip

The combination of Location Wrappers and Low-level Event Trackers is how we build Tracked Contexts and Elements.

Take a loot at this how to build your own Custom Tracked Components guide for more info.

Higher-level

Low-level

Hooks

A range of hooks that we use for most of the tracking. All hooks are stable and perform deep comparisons on their deps.

Event trackers

These hooks can be used to obtain ready-to-trigger callbacks for all Events.

danger

Be careful when using LocationWrappers and Event Tracking hooks in the same Component. Calling a hook-generated event tracking callback in the JSX of the same Component will not produce a valid Location Stack.

Take a loot at this how to build your own Custom Tracked Components guide for more info.

Consumers

React Context consumers meant to retrieve either an entire Context or part of it.


The hooks the SDK uses internally for event instrumentation are also available publicly.

Lifecycle

State

Common

Context Providers

React Context Providers are used to propagate Tracker instances and Location Contexts to all Tracked components.

Higher-level

Lower-level

Factories

Helpers

Tracker Defaults

Location Contexts - Higher-level

Location Contexts - Lower-level

Low-level Event Trackers

caution

Using low-level event trackers directly requires extra attention to the LocationStack and its composition.
It's easy to instrument a callback and forget to wrap the triggering Component in a LocationContext.

Take a loot at this how to build your own Custom Tracked Components guide for more info.