TUISnackBar class

TUISnackBar widget is a lightweight message with an optional action which briefly displays at the bottom of the screen.

Example:

TUISnackBar(
  context: context,
  type: TUISnackBarType.success,
  message: 'This is a success message',
  action: TUISnackBarAction(
    label: 'Dismiss',
    onActionPressed: () {
      ScaffoldMessenger.of(context).hideCurrentSnackBar(
        reason: SnackBarClosedReason.dismiss,
      );
    },
  ),
);
Inheritance

Constructors

TUISnackBar({Key? key, required BuildContext context, TUISnackBarType type = TUISnackBarType.information, required String message, TUISnackBarAction? action, Duration? duration, VoidCallback? onVisible})

Properties

action → SnackBarAction?
(optional) An action that the user can take based on the snack bar.
finalinherited
actionOverflowThreshold → double?
(optional) The percentage threshold for action widget's width before it overflows to a new line.
finalinherited
animation → Animation<double>?
The animation driving the entrance and exit of the snack bar.
finalinherited
backgroundColor → Color?
The snack bar's background color.
finalinherited
behavior → SnackBarBehavior?
This defines the behavior and location of the snack bar.
finalinherited
clipBehavior → Clip
The content will be clipped (or not) according to this option.
finalinherited
closeIconColor → Color?
An optional color for the close icon, if showCloseIcon is true.
finalinherited
content → Widget
The primary content of the snack bar.
finalinherited
dismissDirection → DismissDirection?
The direction in which the SnackBar can be dismissed.
finalinherited
duration → Duration
The amount of time the snack bar should be displayed.
finalinherited
elevation → double?
The z-coordinate at which to place the snack bar. This controls the size of the shadow below the snack bar.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
hitTestBehavior → HitTestBehavior?
Defines how the snack bar area, including margin, will behave during hit testing.
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
margin → EdgeInsetsGeometry?
Empty space to surround the snack bar.
finalinherited
onVisible → VoidCallback?
Called the first time that the snackbar is visible within a Scaffold.
finalinherited
padding → EdgeInsetsGeometry?
The amount of padding to apply to the snack bar's content and optional action.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shape → ShapeBorder?
The shape of the snack bar's Material.
finalinherited
showCloseIcon → bool?
(optional) Whether to include a "close" icon widget.
finalinherited
width → double?
The width of the snack bar.
finalinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<SnackBar>
Creates the mutable state for this widget at a given 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
withAnimation(Animation<double> newAnimation, {Key? fallbackKey}) → SnackBar
Creates a copy of this snack bar but with the animation replaced with the given animation.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited