SyncRefreshIndicator class

A RefreshIndicator wrapper that integrates with Locorda's SyncManager.

This widget provides a standard pull-to-refresh experience that triggers synchronization through the sync manager. It automatically handles:

  • Pull-to-refresh gestures
  • Sync progress indication
  • Error handling

Usage:

SyncRefreshIndicator(
  syncManager: locorda.syncManager,
  child: ListView(
    children: [...],
  ),
)
Inheritance

Constructors

SyncRefreshIndicator({Key? key, required SyncManager syncManager, required Widget child, VoidCallback? onSyncComplete, void onSyncError(Object error)?})
const

Properties

child Widget
The child widget to wrap (typically a scrollable).
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onSyncComplete VoidCallback?
Optional callback when sync completes successfully.
final
onSyncError → void Function(Object error)?
Optional callback when sync fails.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
syncManager → SyncManager
The sync manager to trigger synchronization.
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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