StickyHeader class
Stick Header Widget
Will layout the header above the content unless the overlapHeaders boolean is set to true. The header will remain stuck to the top of its parent Scrollable content.
Place this widget inside a ListView, GridView, CustomScrollView, SingleChildScrollView or similar.
- Inheritance
Constructors
- StickyHeader({Key? key, required Widget header, required Widget content, bool overlapHeaders = false, ScrollController? controller, RenderStickyHeaderCallback? callback})
- Constructs a new StickyHeader widget.
Properties
- callback → RenderStickyHeaderCallback?
-
Optional callback with stickiness value. If you think you need this, then you might want to
consider using StickyHeaderBuilder instead.
final
-
children
→ List<
Widget> -
The widgets below this widget in the tree.
finalinherited
- content → Widget
-
Content to be shown below the header.
final
- controller → ScrollController?
-
Optional ScrollController that will be used by the widget instead of the default inherited one.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- header → Widget
-
Header to be shown at the top of the parent Scrollable content.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- overlapHeaders → bool
-
If true, the header will overlap the Content.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → MultiChildRenderObjectElement -
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
-
createRenderObject(
BuildContext context) → RenderStickyHeader -
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 RenderStickyHeader 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