overlay_support 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.
- OverlaySupport
- OverlaySupportEntry
- OverlaySupportTheme
- SlideDismissible
- Can be dismiss by left or right slide.
- Toast
- ToastThemeData
- Theme data for toast.
- TopSlideNotification
- A notification show in front of screen and shown at the top.
-
TransientKey<
T> - The OverlaySupportEntry associated with TransientKey will be dismiss immediately when next OverlaySupportEntry 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}) → OverlaySupportEntry - Basic api to show overlay widget.
-
showOverlayNotification(
WidgetBuilder builder, {Duration? duration, Key? key, NotificationPosition position = NotificationPosition.top, BuildContext? context}) → OverlaySupportEntry - 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}) → OverlaySupportEntry - 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