ZdsToast class
A container used with ZdsSnackBarExtension.showZdsToast to show a toast.
Typically used to confirm an action has been completed, or to notify the user of errors.
ScaffoldMessenger.of(context).showZdsToast(
ZdsToast(
title: Text('Deleted file'),
leading: const Icon(ZdsIcons.check_circle),
actions: [
IconButton(
onPressed: () => ScaffoldMessenger.of(context).hideCurrentSnackBar(),
icon: const Icon(ZdsIcons.close),
),
],
color: ZdsToastColors.success,
),
);
See also:
- ZdsSnackBarExtension.showZdsToast, used to display a toast message on screen.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- ZdsToast
- Implemented types
- Available Extensions
Constructors
-
ZdsToast({Key? key, Widget? leading, Widget? title, List<
Widget> ? actions, ZdsToastColors? color, bool rounded = true, bool multiLine = false}) -
The contents of a toast, typically used with ZdsSnackBarExtension.showZdsToast.
const
Properties
-
actions
→ List<
Widget> ? -
The actions that will be shown at the end of this widget.
final
- color → ZdsToastColors
-
Determines foreground and background color of toast to comply with design rules.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- leading → Widget?
-
An icon that will be shown before the title.
final
- multiLine → bool
-
Whether to clip this toast to one line or allow multiple lines.
final
- preferredSize → Size
-
The size this widget would prefer if it were otherwise unconstrained.
no setteroverride
- rounded → bool
-
Whether this toast will have rounded corners.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- title → Widget?
-
The main content of this toast.
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's 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.
override
-
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