LocordaStatusWidget class
A combined authentication and sync status widget for the app bar.
This widget shows the current authentication status and reactive
sync state from SyncManager in a compact format suitable for app bars.
It handles the complete user journey from "not connected" → "connecting"
→ "syncing" → "up to date".
Requirements
- auth: Auth instance for authentication state
- syncManager: SyncManager for reactive sync status (required)
Customization
The widget can be customized via:
- iconBuilder: Custom status icon rendering based on state
- onShowLogin: Custom login flow presentation
Both have sensible defaults - only override what you need.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- LocordaStatusWidget
Constructors
-
LocordaStatusWidget({Key? key, required Auth auth, required SyncManager syncManager, required Future<
bool> onShowLogin(BuildContext), Widget iconBuilder(BuildContext, LocordaStatusState)?, StatusMenuCallback? onShowStatusMenu})
Properties
- auth → Auth
-
The Auth instance to monitor for authentication state.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- iconBuilder → Widget Function(BuildContext context, LocordaStatusState state)
-
Custom icon builder. Receives current LocordaStatusState and returns widget.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onShowLogin
→ Future<
bool> Function(BuildContext context) -
Custom login flow. Called when user taps icon while not authenticated.
final
- onShowStatusMenu → StatusMenuCallback
-
Custom status menu. Called when authenticated user taps the icon.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- syncManager → SyncManager
-
Sync manager for reactive sync status updates and sync operations.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< LocordaStatusWidget> -
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