OptimusNotificationsOverlay class
OptimusNotificationsOverlay is an overlay that wraps child inside a stack and provides a method to show an in-app notification.
The position of notifications is determined by OptimusNotificationPosition and by default is set to OptimusNotificationPosition.topRight. You can change the maximum visible count maxVisible when declaring the overlay. Notifications that could not be shown because of the maxVisible limit will be put into a queue and will be dispatched in the order they were added.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- OptimusNotificationsOverlay
Constructors
- OptimusNotificationsOverlay({Key? key, required Widget child, int maxVisible = _defaultMaxVisibleCount, OptimusNotificationPosition position = OptimusNotificationPosition.topRight})
-
const
Properties
- child → Widget
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- maxVisible → int
-
final
- position → OptimusNotificationPosition
-
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(
) → State< StatefulWidget> -
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
Static Methods
-
of(
BuildContext context) → OptimusNotificationManager?