StickyListItem<I> class

Sticky list item that provides header offset calculation

Max and min offset value are defined based on content height

Can be used separately from InfiniteList if needed

Inheritance

Constructors

StickyListItem({required Widget header, required Widget content, required I itemIndex, MinOffsetProvider<I>? minOffsetProvider, StreamSink<StickyState<I>>? streamSink, HeaderMainAxisAlignment mainAxisAlignment = HeaderMainAxisAlignment.start, HeaderCrossAxisAlignment crossAxisAlignment = HeaderCrossAxisAlignment.start, HeaderPositionAxis positionAxis = HeaderPositionAxis.mainAxis, Clip clipBehavior = Clip.hardEdge, Key? key})
Default sticky item constructor with relative header positioning
StickyListItem.overlay({required Widget header, required Widget content, required I itemIndex, MinOffsetProvider<I>? minOffsetProvider, StreamSink<StickyState<I>>? streamSink, HeaderMainAxisAlignment mainAxisAlignment = HeaderMainAxisAlignment.start, HeaderCrossAxisAlignment crossAxisAlignment = HeaderCrossAxisAlignment.start, Clip clipBehavior = Clip.hardEdge, Key? key})
Default sticky item constructor with overlayed header positioning.

Properties

alignment → AlignmentGeometry
How to align the non-positioned and partially-positioned children in the stack.
finalinherited
children → List<Widget>
The widgets below this widget in the tree.
finalinherited
clipBehavior → Clip
The content will be clipped (or not) according to this option.
finalinherited
crossAxisAlignment → HeaderCrossAxisAlignment
Header alignment against cross axis direction
final
fit → StackFit
How to size the non-positioned children in the stack.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
itemIndex → I
Value that will be used inside StickyState object during stream event emit
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
mainAxisAlignment → HeaderMainAxisAlignment
Header alignment against main axis direction
final
minOffsetProvider → MinOffsetProvider<I>?
Callback function that tells when header to stick to the bottom.
final
overlayContent → bool
Defines if header should overlay content
final
positionAxis → HeaderPositionAxis
Header position against scroll axis for relative positioned headers
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
streamSink → StreamSink<StickyState<I>>?
Stream sink object
final
textDirection → TextDirection?
The text direction with which to resolve alignment.
finalinherited

Methods

createElement() → MultiChildRenderObjectElement
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
createRenderObject(BuildContext context) → RenderStack
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, 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
updateRenderObject(BuildContext context, covariant RenderStack 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