DevToolsScrollToTop class
Adds a small "scroll to top" button, shown once the user scrolls down, over the scrollable that builder returns.
Use it in a custom tab so long lists behave like the built-in ones.
Example:
DevToolsScrollToTop(
scrollbar: true,
builder: (context, controller) => ListView.builder(
controller: controller,
itemCount: items.length,
itemBuilder: (context, index) => Text(items[index]),
),
)
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- DevToolsScrollToTop
Constructors
- DevToolsScrollToTop({Key? key, required Widget builder(BuildContext context, ScrollController controller), void onScroll(double offset, ScrollDirection direction)?, bool scrollbar = false})
-
Creates the button over the scrollable built by
builder.const
Properties
- builder → Widget Function(BuildContext context, ScrollController controller)
-
Builds the scrollable; it must attach the given ScrollController, or the button never shows.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onScroll → void Function(double offset, ScrollDirection direction)?
-
Called on every scroll with the offset and direction, e.g. to collapse a header while scrolling down.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollbar → bool
-
Adds an easy-to-grab scrollbar along the right edge, for long lists where flicking alone is slow.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< DevToolsScrollToTop> -
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