SliverFloatingHeader class
A sliver that shows its child when the user scrolls forward and hides it when the user scrolls backwards.
This sliver is preferable to the general purpose SliverPersistentHeader for its relatively narrow use case because there's no need to create a SliverPersistentHeaderDelegate or to predict the header's size.
This example shows how to create a SliverFloatingHeader.
link
To create a local project with this code sample, run:
flutter create --sample=widgets.SliverFloatingHeader.1 mysample
See also:
- PinnedHeaderSliver - which just pins the header at the top of the CustomScrollView.
- SliverResizingHeader - which similarly pins the header at the top of the CustomScrollView but reacts to scrolling by resizing the header between its minimum and maximum extent limits.
- SliverPersistentHeader - a general purpose header that can be configured as a pinned, resizing, or floating header.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- SliverFloatingHeader
Constructors
- SliverFloatingHeader({Key? key, AnimationStyle? animationStyle, FloatingHeaderSnapMode? snapMode, required Widget child})
-
Create a floating header sliver that animates into view when the user
scrolls forward, and disappears the user starts scrolling in the
opposite direction.
const
Properties
- animationStyle → AnimationStyle?
-
Non null properties override the default durations (300ms) and
curves (Curves.easeInOut) for subsequent header animations.
final
- child → Widget
-
The widget contained by this sliver.
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
- snapMode → FloatingHeaderSnapMode?
-
Specifies how a partially visible SliverFloatingHeader animates
into a view when a user scroll gesture ends.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< SliverFloatingHeader> -
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