YaruScrollViewUndershoot class
A widget that displays an undershoot at the start and/or end of a scroll view, when the scroll offset is not at the very beginning or end.
See also:
- YaruScrollViewUndershoot.builder, if you dont't want to create a ScrollController yourself.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- YaruScrollViewUndershoot
Constructors
- YaruScrollViewUndershoot({Key? key, required ScrollController controller, Axis scrollDirection = Axis.vertical, bool startUndershoot = true, bool endUndershoot = true, required Widget child})
-
Create a widget that displays an undershoot at the start and/or end of a scroll view,
when the scroll offset is not at the very beginning or end.
const
- YaruScrollViewUndershoot.builder({Key? key, Axis scrollDirection = Axis.vertical, bool startUndershoot = true, bool endUndershoot = true, required Widget builder(BuildContext, ScrollController)?})
-
when the scroll offset is not at the very beginning or end.
const
Properties
- builder → Widget Function(BuildContext, ScrollController)?
-
The child of this widget.
It passes a controller that needs to manage the related scroll view.
final
- child → Widget?
-
The child of this widget.
Should be the scroll view, managed by the controller.
final
- controller → ScrollController?
-
Controller that manage the related scroll view.
final
- endUndershoot → bool
-
If true, this widget will show an undershoot
when the scroll offset is not at the very end.
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
- scrollDirection → Axis
-
Scroll direction of the related scroll view.
final
- startUndershoot → bool
-
If true, this widget will show an undershoot
when the scroll offset is not at the very beginning.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< YaruScrollViewUndershoot> -
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