TickkiAnalyticsScope class

Root-level wrapper that:

  1. Makes analytics available to descendants via an InheritedWidget (consumed by TickkiTrackable etc.), and
  2. Optionally captures every pointer tap and emits a coordinate-tagged tap event so the SDK collects an ambient heatmap even without any per-button instrumentation.

Wrap once at the root:

runApp(TickkiAnalyticsScope(
  analytics: tickki.analytics,
  child: const MyApp(),
));

Pass captureTaps: false to disable the ambient pointer listener (the InheritedWidget surface stays available either way). Pass child: wrapped in TickkiIgnore to opt subtrees out of the ambient capture — useful for sensitive forms.

Note: ambient capture only emits coordinates and the containing screen — it does not walk the Semantics tree to recover a button label. For richer named events on specific widgets, use TickkiTrackable (one wrapper per important button). Semantic auto-discovery is on the roadmap for a future patch.

Inheritance

Constructors

TickkiAnalyticsScope({Key? key, required TickkiAnalytics analytics, required Widget child, bool captureTaps = true})
const

Properties

analytics → TickkiAnalytics
final
captureTaps → bool
When true (default), every pointer-up that follows a brief pointer-down fires a tap event with x/y and the current route name. Disable if you want fully manual tracking.
final
child → Widget
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<TickkiAnalyticsScope>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

maybeOf(BuildContext context) → TickkiAnalytics?
Look up the nearest ancestor scope. Returns null if no scope is installed — callers should fall back gracefully.
of(BuildContext context) → TickkiAnalytics
Look up the nearest ancestor scope or throw. Use inside TickkiTrackable builders where the scope is required.