SnackBar class Null safety

A lightweight message with an optional action which briefly displays at the bottom of the screen.

To display a snack bar, call ScaffoldMessenger.of(context).showSnackBar(), passing an instance of SnackBar that describes the message.

To control how long the SnackBar remains visible, specify a duration.

A SnackBar with an action will not time out when TalkBack or VoiceOver are enabled. This is controlled by AccessibilityFeatures.accessibleNavigation.

Here is an example of a SnackBar with an action button implemented using SnackBarAction.
To create a local project with this code sample, run:
flutter create --sample=material.SnackBar.1 mysample

Here is an example of a customized SnackBar. It utilizes behavior, shape, padding, width, and duration to customize the location, appearance, and the duration for which the SnackBar is visible.
To create a local project with this code sample, run:
flutter create --sample=material.SnackBar.2 mysample

See also:



SnackBar({Key? key, required Widget content, Color? backgroundColor, double? elevation, EdgeInsetsGeometry? margin, EdgeInsetsGeometry? padding, double? width, ShapeBorder? shape, SnackBarBehavior? behavior, SnackBarAction? action, Duration duration = _snackBarDisplayDuration, Animation<double>? animation, VoidCallback? onVisible, DismissDirection dismissDirection = DismissDirection.down, Clip clipBehavior = Clip.hardEdge})
Creates a snack bar.


action SnackBarAction?
(optional) An action that the user can take based on the snack bar.
animation Animation<double>?
The animation driving the entrance and exit of the snack bar.
backgroundColor Color?
The snack bar's background color. If not specified it will use SnackBarThemeData.backgroundColor of ThemeData.snackBarTheme. If that is not specified it will default to a dark variation of ColorScheme.surface for light themes, or ColorScheme.onSurface for dark themes.
behavior SnackBarBehavior?
This defines the behavior and location of the snack bar.
clipBehavior Clip
The content will be clipped (or not) according to this option.
content Widget
The primary content of the snack bar.
dismissDirection DismissDirection
The direction in which the SnackBar can be dismissed.
duration Duration
The amount of time the snack bar should be displayed.
elevation double?
The z-coordinate at which to place the snack bar. This controls the size of the shadow below the snack bar.
hashCode int
The hash code for this object.
@nonVirtual, read-only, inherited
key Key?
Controls how one widget replaces another widget in the tree.
final, inherited
margin EdgeInsetsGeometry?
Empty space to surround the snack bar.
onVisible VoidCallback?
Called the first time that the snackbar is visible within a Scaffold.
padding EdgeInsetsGeometry?
The amount of padding to apply to the snack bar's content and optional action.
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
shape ShapeBorder?
The shape of the snack bar's Material.
width double?
The width of the snack bar.


createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
createState() State<SnackBar>
Creates the mutable state for this widget at a given location in the tree.
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
toString({DiagnosticLevel minLevel =}) String
A string representation of this object.
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
toStringShort() String
A short, textual description of this widget.
withAnimation(Animation<double> newAnimation, {Key? fallbackKey}) SnackBar
Creates a copy of this snack bar but with the animation replaced with the given animation.


operator ==(Object other) bool
The equality operator.
@nonVirtual, inherited

Static Methods

createAnimationController({required TickerProvider vsync}) AnimationController
Creates an animation controller useful for driving a snack bar's entrance and exit animation.