SnackbarService class
A service that allows the user to show the snackbar from a ViewModel
- Inheritance
-
- Object
- GetLifeCycle
- DisposableInterface
- GetxService
- SnackbarService
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- initialized → bool
-
Checks whether the controller has already been initialized.
no setterinherited
- isClosed → bool
-
Checks whether the controller has already been closed.
no setterinherited
- isOpen → bool?
-
Checks if there is a snackbar open
no setter
- isSnackbarOpen → bool?
-
Check if snackbar is open
no setter
-
onDelete
→ InternalFinalCallback<
void> -
Internal callback that starts the cycle of this controller.
finalinherited
-
onStart
→ InternalFinalCallback<
void> -
Called at the exact moment the widget is allocated in memory.
It uses an internal "callable" type, to avoid any @overrides in subclases.
This method should be internal and is required to define the
lifetime cycle of the subclass.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
$configureLifeCycle(
) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onClose(
) → void -
Called before onDelete method. onClose might be used to
dispose resources used by the controller. Like closing events,
or streams before the controller is destroyed.
Or dispose objects that can potentially create some memory leaks,
like TextEditingControllers, AnimationControllers.
Might be useful as well to persist some data on disk.
inherited
-
onInit(
) → void -
Called immediately after the widget is allocated in memory.
You might use this to initialize something for the controller.
inherited
-
onReady(
) → void -
Called 1 frame after onInit(). It is the perfect place to enter
navigation events, like snackbar, dialogs, or a new route, or
async request.
inherited
-
registerCustomMainButtonBuilder(
{required dynamic variant, required Widget builder(String?, Function?)?}) → void -
Registers a builder that will be used when showing a matching variant value. The builder
function takes in a String to display as the title and a
Function
to be used to the onTap callback -
registerCustomSnackbarConfig(
{required dynamic variant, SnackbarConfig? config, SnackbarConfig configBuilder()?}) → void -
Saves the
config
against the value ofvariant
. AconfigBuilder
can also be supplied which will be chosen over the config for the same variant when requested. -
registerSnackbarConfig(
SnackbarConfig config) → void -
Saves the
config
to be used for the showSnackbar function -
showCustomSnackBar(
{required String message, required dynamic variant, String? title, String? mainButtonTitle, void onMainButtonTapped()?, Function? onTap, Duration duration = const Duration(seconds: 1)}) → Future? -
showSnackbar(
{String title = '', required String message, dynamic onTap(dynamic)?, Duration duration = const Duration(seconds: 3), String? mainButtonTitle, void onMainButtonTapped()?, Widget? icon}) → void - Shows a snack bar with the details passed in
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited