StretchingOverscrollIndicator class Null safety

A Material Design visual indication that a scroll view has overscrolled.

A StretchingOverscrollIndicator listens for ScrollNotifications in order to stretch the content of the Scrollable. These notifications are typically generated by a ScrollView, such as a ListView or a GridView.

When triggered, the StretchingOverscrollIndicator generates an OverscrollIndicatorNotification before showing an overscroll indication. To prevent the indicator from showing the indication, call OverscrollIndicatorNotification.disallowIndicator on the notification.

Created by ScrollBehavior.buildOverscrollIndicator on platforms (e.g., Android) that commonly use this type of overscroll indication when ScrollBehavior.androidOverscrollIndicator is AndroidOverscrollIndicator.stretch. Otherwise, the default GlowingOverscrollIndicator is applied. ScrollBehavior.androidOverscrollIndicator is deprecated, use ThemeData.useMaterial3, or override ScrollBehavior.buildOverscrollIndicator to choose the desired indicator.

See also:



StretchingOverscrollIndicator({Key? key, required AxisDirection axisDirection, ScrollNotificationPredicate notificationPredicate = defaultScrollNotificationPredicate, Clip clipBehavior = Clip.hardEdge, Widget? child})
Creates a visual indication that a scroll view has overscrolled by applying a stretch transformation to the content.


axis Axis
The axis along which scrolling occurs in the Scrollable whose overscrolls are to be visualized.
axisDirection AxisDirection
The direction of positive scroll offsets in the Scrollable whose overscrolls are to be visualized.
child Widget?
The widget below this widget in the tree.
clipBehavior Clip
The content will be clipped (or not) according to this option.
hashCode int
The hash code for this object.
@nonVirtual, read-only, inherited
key Key?
Controls how one widget replaces another widget in the tree.
final, inherited
notificationPredicate ScrollNotificationPredicate
A check that specifies whether a ScrollNotification should be handled by this widget.
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited


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


operator ==(Object other) bool
The equality operator.
@nonVirtual, inherited