MessageOverlayListener class

A listener for ChangeNotifier that extends MessageNotifierMixin mixin Wrapping a widget with MessageListener will use Scaffold.context to show Snackbars called from the ChangeNotifier class with notifyError or notifyInfo methods Useful to display error or information messages

As an example:

ChangeNotifierProvider.value(
  value: _model,
  child: Scaffold(
   appBar: AppBar(),
   body: MessageListener<Model>(
      child: ListView()
   )
  )
);
Inheritance

Constructors

MessageOverlayListener({Key? key, required Widget child, required ProviderBase provider, String? errorExtractor(dynamic)?, String? infoExtractor(dynamic)?, void onError(String error)?, void onErrorTap(String error)?, Color errorBackgroundColor = Colors.red, Color errorColor = Colors.white, Widget errorLeading = const Icon(Icons.error, color: Colors.white), Widget? errorTrailing, void onInfo(String info)?, void onInfoTap(String info)?, Color infoBackgroundColor = Colors.lightBlue, Color infoColor = Colors.white, Widget infoLeading = const Icon(Icons.info, color: Colors.white), Widget? infoTrailing})
const

Properties

child → Widget
final
errorBackgroundColor → Color
Customize error Overlay background color default to Colors.red600
final
errorColor → Color
Customize error Overlay text color default to Colors.white
final
errorExtractor → (String? Function(dynamic)?)
final
errorLeading → Widget
Customize error Overlay leading icon default to Icons.error
final
errorTrailing → Widget?
Customize error Overlay trailing widget Default is empty
final
hashCode → int
The hash code for this object.
no setterinherited
infoBackgroundColor → Color
Customize info Overlay background color default to Colors.red600
final
infoColor → Color
Customize info Overlay text color default to Colors.white
final
infoExtractor → (String? Function(dynamic)?)
final
infoLeading → Widget
Customize info Overlay leading default to Icons.info
final
infoTrailing → Widget?
Customize info Overlay trailing widget Default is empty
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onError → (void Function(String error)?)
Additional function that can be called when an error message occur
final
onErrorTap → (void Function(String error)?)
if onErrorTap is not null an action will be added to the Overlay when an error message occur
final
onInfo → (void Function(String info)?)
Additional function that can be called when an info message occur
final
onInfoTap → (void Function(String info)?)
if onInfoTap is not null an action will be added to the Overlay when an info message occur
final
provider → ProviderBase
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → MessageOverlayListenerState
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}) → 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