GiffyDialog class
A Giffy Dialog based on Material Design alert dialog.
An giffy dialog informs the user about situations that require acknowledgment. An giffy dialog has an optional title and an optional list of actions. The title is displayed above the content and the actions are displayed below the content.
If the content is too large to fit on the screen vertically, the dialog will display the title and the actions and let the content overflow, which is rarely desired. Consider using a scrolling widget for content, such as SingleChildScrollView, to avoid overflow. (However, be aware that since GiffyDialog tries to size itself using the intrinsic dimensions of its children, widgets such as ListView, GridView, and CustomScrollView, which use lazy viewports, will not work.)
Typically passed as the child widget to showDialog, which displays the dialog.
{@tool snippet}
This snippet shows a method in a State which, when called, displays a giffy dialog and returns a Future that completes when the dialog is dismissed.
Future<void> _showMyDialog() async {
return showDialog<void>(
context: context,
barrierDismissible: false, // user must tap button!
builder: (BuildContext context) {
return GiffyDialog(
giffy: Image.asset('assets/giffy_dialog.gif'),
title: const Text('GiffyDialog Title'),
content: SingleChildScrollView(
child: ListBody(
children: const <Widget>[
Text('This is a demo giffy dialog.'),
Text('Would you like to approve of this message?'),
],
),
),
actions: <Widget>[
TextButton(
child: const Text('Approve'),
onPressed: () {
Navigator.of(context).pop();
},
),
],
);
},
);
}
{@end-tool}
See also:
- showDialog, which actually displays the dialog and returns its result.
- material.io/design/components/dialogs.html#alert-dialog
- m3.material.io/components/dialogs
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- GiffyDialog
Constructors
-
GiffyDialog({Key? key, required Widget giffy, GiffyBuilder giffyBuilder = defaultGiffyBuilder, EdgeInsetsGeometry? giffyPadding, Widget? title, EdgeInsetsGeometry? titlePadding, TextStyle? titleTextStyle, Widget? content, EdgeInsetsGeometry? contentPadding, TextStyle? contentTextStyle, List<
Widget> ? actions, EdgeInsetsGeometry? actionsPadding, MainAxisAlignment? actionsAlignment, VerticalDirection? actionsOverflowDirection, double? actionsOverflowButtonSpacing, OverflowBarAlignment? actionsOverflowAlignment, EdgeInsetsGeometry? buttonPadding, Color? backgroundColor, double? elevation, Color? shadowColor, Color? surfaceTintColor, EdgeInsets insetPadding = _defaultInsetPadding, Clip clipBehavior = Clip.antiAlias, ShapeBorder? shape, AlignmentGeometry? alignment, String? semanticLabel, bool scrollable = false, EntryAnimation entryAnimation = EntryAnimation.none}) -
Creates an giffy dialog.
const
-
GiffyDialog.image(Image image, {Key? key, GiffyBuilder giffyBuilder = defaultGiffyBuilder, EdgeInsetsGeometry? giffyPadding, Widget? title, EdgeInsetsGeometry? titlePadding, TextStyle? titleTextStyle, Widget? content, EdgeInsetsGeometry? contentPadding, TextStyle? contentTextStyle, List<
Widget> ? actions, EdgeInsetsGeometry? actionsPadding, MainAxisAlignment? actionsAlignment, VerticalDirection? actionsOverflowDirection, double? actionsOverflowButtonSpacing, OverflowBarAlignment? actionsOverflowAlignment, EdgeInsetsGeometry? buttonPadding, Color? backgroundColor, double? elevation, Color? shadowColor, Color? surfaceTintColor, EdgeInsets insetPadding = _defaultInsetPadding, Clip clipBehavior = Clip.antiAlias, ShapeBorder? shape, AlignmentGeometry? alignment, String? semanticLabel, bool scrollable = false, EntryAnimation entryAnimation = EntryAnimation.none}) -
Creates a giffy dialog which uses a Image as the giffy.
const
-
GiffyDialog.lottie(LottieBuilder lottie, {Key? key, GiffyBuilder giffyBuilder = defaultGiffyBuilder, EdgeInsetsGeometry? giffyPadding, Widget? title, EdgeInsetsGeometry? titlePadding, TextStyle? titleTextStyle, Widget? content, EdgeInsetsGeometry? contentPadding, TextStyle? contentTextStyle, List<
Widget> ? actions, EdgeInsetsGeometry? actionsPadding, MainAxisAlignment? actionsAlignment, VerticalDirection? actionsOverflowDirection, double? actionsOverflowButtonSpacing, OverflowBarAlignment? actionsOverflowAlignment, EdgeInsetsGeometry? buttonPadding, Color? backgroundColor, double? elevation, Color? shadowColor, Color? surfaceTintColor, EdgeInsets insetPadding = _defaultInsetPadding, Clip clipBehavior = Clip.antiAlias, ShapeBorder? shape, AlignmentGeometry? alignment, String? semanticLabel, bool scrollable = false, EntryAnimation entryAnimation = EntryAnimation.none}) -
Creates a giffy dialog which uses a LottieBuilder as the giffy.
const
-
GiffyDialog.rive(RiveAnimation rive, {Key? key, GiffyBuilder giffyBuilder = defaultGiffyBuilder, EdgeInsetsGeometry? giffyPadding, Widget? title, EdgeInsetsGeometry? titlePadding, TextStyle? titleTextStyle, Widget? content, EdgeInsetsGeometry? contentPadding, TextStyle? contentTextStyle, List<
Widget> ? actions, EdgeInsetsGeometry? actionsPadding, MainAxisAlignment? actionsAlignment, VerticalDirection? actionsOverflowDirection, double? actionsOverflowButtonSpacing, OverflowBarAlignment? actionsOverflowAlignment, EdgeInsetsGeometry? buttonPadding, Color? backgroundColor, double? elevation, Color? shadowColor, Color? surfaceTintColor, EdgeInsets insetPadding = _defaultInsetPadding, Clip clipBehavior = Clip.antiAlias, ShapeBorder? shape, AlignmentGeometry? alignment, String? semanticLabel, bool scrollable = false, EntryAnimation entryAnimation = EntryAnimation.none}) -
Creates a giffy dialog which uses a RiveAnimation as the giffy.
const
Properties
-
actions
→ List<
Widget> ? -
The (optional) set of actions that are displayed at the bottom of the
modal with an OverflowBar.
final
- actionsAlignment → MainAxisAlignment?
-
final
- actionsOverflowAlignment → OverflowBarAlignment?
-
final
- actionsOverflowButtonSpacing → double?
-
The spacing between actions when the OverflowBar switches
to a column layout because the actions don't fit horizontally.
final
- actionsOverflowDirection → VerticalDirection?
-
The vertical direction of actions if the children overflow
horizontally.
final
- actionsPadding → EdgeInsetsGeometry?
-
Padding around the set of actions at the bottom of the modal.
final
- alignment → AlignmentGeometry?
-
How to align the Dialog.
final
- backgroundColor → Color?
-
The background color of the surface of this Dialog.
final
-
final
- clipBehavior → Clip
-
Controls how the contents of the dialog are clipped (or not) to the given
shape.
final
- content → Widget?
-
The (optional) content of the modal is displayed in the center of the
modal in a lighter font.
final
- contentPadding → EdgeInsetsGeometry?
-
Padding around the content.
final
- contentTextStyle → TextStyle?
-
Style for the text in the content of this
Alertmodal
.final - elevation → double?
-
The z-coordinate of this Dialog.
final
- entryAnimation → EntryAnimation
-
The animation to use when the modal is shown.
final
- giffy → Widget
-
The widget or the gif to be displayed at the top of the modal.
final
- giffyBuilder → GiffyBuilder
-
Builder that is called to build the giffy.
final
- giffyPadding → EdgeInsetsGeometry?
-
Padding around the giffy.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- insetPadding → EdgeInsets
-
The amount of padding added to MediaQueryData.viewInsets on the outside
of the dialog. This defines the minimum space between the screen's edges
and the dialog.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollable → bool
-
Determines whether the title and content widgets are wrapped in a
scrollable.
final
- semanticLabel → String?
-
The semantic label of the modal used by accessibility frameworks to
announce screen transitions when the modal is opened and closed.
final
- shadowColor → Color?
-
The color used to paint a drop shadow under the dialog's Material,
which reflects the dialog's elevation.
final
- shape → ShapeBorder?
-
The shape of this dialog's border.
final
- surfaceTintColor → Color?
-
The color used as a surface tint overlay on the dialog's background color,
which reflects the dialog's elevation.
final
- title → Widget?
-
The (optional) title of the modal is displayed in a large font at the top
of the modal, below the giffy.
final
- titlePadding → EdgeInsetsGeometry?
-
Padding around the title.
final
- titleTextStyle → TextStyle?
-
Style for the text in the title of this
GiffyModal
.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.
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