InAppBanner class
A non-intrusive in-app notification banner that slides in from the top or bottom and auto-dismisses after displayDuration.
Supports tap, swipe-to-dismiss, and programmatic dismissal via InAppBannerService.hide.
Typically you use InAppBannerService.show rather than placing this widget directly in the tree.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- InAppBanner
Constructors
- InAppBanner({Key? key, required String message, String? title, IconData? icon, Color? backgroundColor, Color? foregroundColor, Duration displayDuration = const Duration(seconds: 4), VoidCallback? onTap, VoidCallback? onDismiss, InAppBannerPosition position = InAppBannerPosition.top})
-
Creates an in-app notification banner.
const
Properties
- backgroundColor → Color?
-
Background colour (default: dark charcoal).
final
- displayDuration → Duration
-
How long the banner remains visible.
final
- foregroundColor → Color?
-
Text and icon colour (default: white).
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- icon → IconData?
-
Optional leading icon.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- message → String
-
The primary notification message.
final
- onDismiss → VoidCallback?
-
Called when the banner is dismissed.
final
- onTap → VoidCallback?
-
Called when the user taps the banner.
final
- position → InAppBannerPosition
-
Banner entry position.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- title → String?
-
Optional title displayed in bold above the message.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< InAppBanner> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited