SentryDisplayWidget class

A widget that reports the Time To Initially Displayed (TTID) of its child widget.

This widget wraps around another widget to measure and report the time it takes for the child widget to be initially displayed on the screen. This method allows a more accurate measurement than what the default TTID implementation provides. The TTID measurement begins when the route to the widget is pushed and ends when addPostFramecallback is triggered.

Wrap the widget you want to measure with SentryDisplayWidget, and ensure that you have set up Sentry's routing instrumentation according to the Sentry documentation.

SentryDisplayWidget(
  child: MyWidget(),
)

Make sure to configure Sentry's routing instrumentation in your app by following the guidelines provided in Sentry's documentation for Flutter integrations: https://docs.sentry.io/platforms/flutter/integrations/routing-instrumentation/

See also:

• Sentry's documentation on Flutter integrations for more information on how to integrate Sentry into your Flutter application.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• SentryDisplayWidget

Constructors

SentryDisplayWidget({Key? key, required Widget child, @visibleForTesting FrameCallbackHandler? frameCallbackHandler})

Properties

child → Widget

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → _SentryDisplayWidgetState

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}) → 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