Overlayer class
A manager class extending BotToast for overlay management.
Constructors
- Overlayer.closeOverlay({int backgroundColor = 0x42000000, int seconds = 0, bool clickClose = false, bool allowClick = false, bool ignoreContentClick = false, bool crossPage = true, int animationMilliseconds = 200, int animationReverseMilliseconds = 200, BackButtonBehaviorChecker backButtonBehavior = BackButtonBehaviorChecker.none, void cancelFunc()?})
- Constructs an OverLaymanager instance to close an overlay.
- Overlayer.showOverlay({int backgroundColor = 0x42000000, int seconds = 0, bool clickClose = false, bool allowClick = false, bool ignoreContentClick = false, bool crossPage = true, int animationMilliseconds = 200, int animationReverseMilliseconds = 200, BackButtonBehaviorChecker backButtonBehavior = BackButtonBehaviorChecker.none, void cancelFunc()?, required Widget child})
- Constructs an OverLaymanager instance to show an overlay.
Properties
- allowClick → bool
-
Determines if clicking outside the overlay area will close it.
final
- animationMilliseconds → int
-
The duration for the overlay animation to complete when it appears.
final
- animationReverseMilliseconds → int
-
The duration for the overlay animation to complete when it disappears.
final
- backButtonBehavior → BackButtonBehaviorChecker
-
The behavior to apply when the back button is pressed.
final
- backgroundColor → int
-
The background color of the overlay.
final
- cancelFunc ↔ void Function()?
-
A callback function to be invoked when the overlay is closed.
getter/setter pair
- clickClose → bool
-
Determines if clicking on the overlay will close it.
final
- crossPage → bool
-
Determines if the overlay should persist across multiple pages.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- ignoreContentClick → bool
-
Determines if clicking on the content within the overlay will be ignored.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- seconds → int
-
The duration for which the overlay will be displayed.
final
Methods
-
getBackButtonBehavior(
{required BackButtonBehaviorChecker backButtonBehavior}) → BackButtonBehavior -
Returns the corresponding BackButtonBehavior based on the provided
backButtonBehavior. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited