overlay_notification library

Classes

BottomSlideNotification
a notification show in front of screen and shown at the bottom
ModalKey<T>
showOverlay with block other show with the same ModalKey.
OverlayNotification
OverlayNotificationEntry
OverlayNotificationTheme
SlideDismissible
Can be dismiss by left or right slide.
Toast
ToastListOverlay<T>
ToastListOverlayState<T>
ToastThemeData
Theme data for toast.
ToastTimer<T>
TopSlideNotification
A notification show in front of screen and shown at the top.
TransientKey<T>
The OverlayNotificationEntry associated with TransientKey will be dismiss immediately when next OverlayNotificationEntry showing by showOverlay with the same key.

Enums

NotificationPosition
Indicates if notification is going to show at the top or at the bottom.

Properties

kNotificationDuration ↔ Duration
The length of time the notification is fully displayed.
getter/setter pair
kNotificationSlideDuration ↔ Duration
Notification display or hidden animation duration.
getter/setter pair

Functions

showOverlay(AnimatedOverlayWidgetBuilder builder, {Curve? curve, Duration? duration, Key? key, BuildContext? context, Duration? animationDuration, Duration? reverseAnimationDuration}) → OverlayNotificationEntry
Basic api to show overlay widget.
showOverlayNotification(WidgetBuilder builder, {Duration? duration, Key? key, NotificationPosition position = NotificationPosition.top, BuildContext? context}) → OverlayNotificationEntry
Popup a notification at the top of screen.
showSimpleNotification(Widget content, {Widget? leading, Widget? subtitle, Widget? trailing, EdgeInsetsGeometry? contentPadding, Color? background, Color? foreground, double elevation = 16, Duration? duration, Key? key, bool autoDismiss = true, bool slideDismiss = false, NotificationPosition position = NotificationPosition.top, BuildContext? context, DismissDirection? slideDismissDirection, AlignmentGeometry? alignment, EdgeInsetsGeometry? padding, Color? color, Decoration? decoration, Decoration? foregroundDecoration, double? width, double? height, BoxConstraints? constraints, EdgeInsetsGeometry? margin, Matrix4? transform, AlignmentGeometry? transformAlignment, Clip clipBehavior = Clip.none, MaterialType type = MaterialType.canvas, Color? shadowColor, Color? surfaceTintColor, TextStyle? textStyle, BorderRadiusGeometry? borderRadius, ShapeBorder? shape, bool borderOnForeground = true, Duration animationDuration = kThemeChangeDuration}) → OverlayNotificationEntry
Show a simple notification above the top of window.
toast(String message, {Duration duration = Toast.LENGTH_SHORT, BuildContext? context}) → void
Popup a message in front of screen.

Typedefs

AnimatedOverlayWidgetBuilder = Widget Function(BuildContext context, double progress)
To build a widget with animated value. progress : the progress of overlay animation from 0 - 1
ToastListItemBuilder<T> = Widget Function(BuildContext context, T item, int index, Animation<double> animation)