BannerWidget class

An in-flow banner that surfaces a short, severity-coloured message inside a layout (e.g. "You're offline" or "Saved successfully").

Different from DynamicMessageWidget, which is content-card oriented (image + title + description). BannerWidget is a single-line status strip with a leading icon and optional dismiss button.

BannerWidget(
  severity: BannerSeverity.warning,
  message: 'You are offline. Changes will sync when you reconnect.',
  isDismissible: true,
  onDismiss: _hideOfflineBanner,
)
Inheritance
Available extensions

Constructors

BannerWidget({Key? key, required BannerSeverity severity, required String message, String? title, bool isDismissible = false, VoidCallback? onDismiss, IconData? icon})
Creates a banner.
const

Properties

defaultHorizontalSpace → SizedBox

Available on Widget, provided by the WidgetExtension extension

no setter
defaultVerticalSpace → SizedBox

Available on Widget, provided by the WidgetExtension extension

no setter
hashCode → int
The hash code for this object.
no setterinherited
icon → IconData?
Override the leading icon. Defaults to a severity-appropriate Material icon (info_outline, warning_amber, error_outline, check_circle_outline).
final
isDismissible → bool
When true a trailing close button is rendered. The handler must be supplied via onDismiss when this is true.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
message → String
Banner copy. Plain text — for rich content prefer DynamicMessageWidget.
final
onDismiss → VoidCallback?
Called when the dismiss button is tapped.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
severity → BannerSeverity
Severity controls the leading icon and the tint applied to the border + background.
final
title → String?
Optional title rendered above the message in a heavier weight.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
center() → Center

Available on Widget, provided by the WidgetExtension extension

createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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
lightGreyBackground({required BuildContext context}) → Container

Available on Widget, provided by the WidgetExtension extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onTap(GestureTapCallback callback, {VoidCallback? onLongPress}) → InkWell

Available on Widget, provided by the WidgetExtension extension

padAll({double? value}) → Padding

Available on Widget, provided by the WidgetExtension extension

padBottom({double? bottom}) → Padding

Available on Widget, provided by the WidgetExtension extension

padHorizontal({double? horizontal}) → Padding

Available on Widget, provided by the WidgetExtension extension

padLeft({double? left}) → Padding

Available on Widget, provided by the WidgetExtension extension

padRight({double? right}) → Padding

Available on Widget, provided by the WidgetExtension extension

padTop({double? top}) → Padding

Available on Widget, provided by the WidgetExtension extension

padVertical({double? vertical}) → Padding

Available on Widget, provided by the WidgetExtension extension

padZero() → Padding

Available on Widget, provided by the WidgetExtension extension

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
visible(bool visible, {Widget? defaultWidget}) → Widget

Available on Widget, provided by the WidgetExtension extension

set visibility

Operators

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