ToastrService class

Service to manage and display toastr notifications with stacking, queueing, lifecycle awareness, and security features.

Zero setup required. Just install the package and call methods directly:

ToastrHelper.success('Done!');
ToastrHelper.error('Something went wrong');

The service automatically finds the app's overlay — no BuildContext, no navigatorKey, and no init() needed.

Mixed-in types

WidgetsBindingObserver

Constructors

ToastrService(): Factory constructor that returns the singleton instance
factory

Properties

activeCount → int: Get the number of currently active toastrs
no setter
hasActiveToastrs → bool: Check if there are any active toastrs
no setter
hashCode → int: The hash code for this object.
no setterinherited
maxVisible ↔ int: Maximum number of toasts visible on screen at once.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

clearAll() → void: Clear all active toastrs
clearLast() → void: Clear the last (most recent) toastr
didChangeAccessibilityFeatures() → void: Called when the system changes the set of currently active accessibility features.
inherited
didChangeAppLifecycleState(AppLifecycleState state) → void: Called when the system puts the app in the background or returns the app to the foreground.
override
didChangeLocales(List<Locale>? locales) → void: Called when the system tells the app that the user's locale has changed. For example, if the user changes the system language settings.
inherited
didChangeMetrics() → void: Called when the application's dimensions change. For example, when a phone is rotated.
inherited
didChangePlatformBrightness() → void: Called when the platform brightness changes.
inherited
didChangeTextScaleFactor() → void: Called when the platform's text scale factor changes.
inherited
didChangeViewFocus(ViewFocusEvent event) → void: Called whenever the PlatformDispatcher receives a notification that the focus state on a view has changed.
inherited
didHaveMemoryPressure() → void: Called when the system is running low on memory.
inherited
didPopRoute() → Future<bool>: Called when the system tells the app to pop the current route, such as after a system back button press or back gesture.
inherited
didPushRoute(String route) → Future<bool>: Called when the host tells the application to push a new route onto the navigator.
inherited
didPushRouteInformation(RouteInformation routeInformation) → Future<bool>: Called when the host tells the application to push a new RouteInformation and a restoration state onto the router.
inherited
didRequestAppExit() → Future<AppExitResponse>: Called when a request is received from the system to exit the application.
inherited
dismiss(String id) → void: Dismiss a specific toast by its id.
dispose() → void: Clean up resources and clear all active notifications
handleCancelBackGesture() → void: Called when a predictive back gesture is canceled, indicating that no navigation should occur.
inherited
handleCommitBackGesture() → void: Called when a predictive back gesture is finished successfully, indicating that the current route should be popped.
inherited
handleStartBackGesture(PredictiveBackEvent backEvent) → bool: Called at the start of a predictive back gesture.
inherited
handleStatusBarTap() → void: Called when the user taps the status bar on iOS, to scroll a scroll view to the top.
inherited
handleUpdateBackGestureProgress(PredictiveBackEvent backEvent) → void: Called when a predictive back gesture moves.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
pauseTimer(String id) → void: Pause a specific toast's auto-dismiss timer (e.g. on hover).
removeToast(String toastId) → void: Called when a toast should be removed (timer or widget dismiss).
resumeTimer(String id) → void: Resume a specific toast's auto-dismiss timer.
show(ToastrConfig config) → String: Show a toastr notification with the given configuration.
toString() → String: A string representation of this object.
inherited
update(String id, ToastrConfig config) → String: Update an existing toast identified by id with a new config.

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

instance → ToastrService: Global instance for easy access
no setter