SliverStickyHeader class

A sliver that displays a header before its sliver. The header scrolls off the viewport only when the sliver does.

Place this widget inside a CustomScrollView or similar.

Inheritance

Constructors

SliverStickyHeader({Key? key, Widget? header, Widget? sliver, bool overlapsContent = false, bool sticky = true, StickyHeaderController? controller})
Creates a sliver that displays the header before its sliver, unless overlapsContent it's true. The header stays pinned when it hits the start of the viewport until the sliver scrolls off the viewport.
SliverStickyHeader.builder({Key? key, required SliverStickyHeaderWidgetBuilder builder, Widget? sliver, bool overlapsContent = false, bool sticky = true, StickyHeaderController? controller})
Creates a widget that builds the header of a SliverStickyHeader each time its scroll percentage changes.

Properties

controller → StickyHeaderController?
The controller used to interact with this sliver.
final
hashCode → int
The hash code for this object.
no setterinherited
The header to display before the sliver.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
overlapsContent → bool
Whether the header should be drawn on top of the sliver instead of before.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sliver → Widget?
The sliver to display after the header.
final
sticky → bool
Whether to stick the header. Defaults to true.
final

Methods

createElement() → SliverStickyHeaderRenderObjectElement
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
override
createRenderObject(BuildContext context) → RenderSliverStickyHeader
Creates an instance of the RenderObject class that this RenderObjectWidget represents, using the configuration described by this RenderObjectWidget.
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
didUnmountRenderObject(covariant RenderObject renderObject) → void
A render object previously associated with this widget has been removed from the tree. The given RenderObject will be of the same type as returned by this object's createRenderObject.
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
updateRenderObject(BuildContext context, covariant RenderSliverStickyHeader renderObject) → void
Copies the configuration described by this RenderObjectWidget to the given RenderObject, which will be of the same type as returned by this object's createRenderObject.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited