TBanner class

A non-modal in-page contextual alert banner or callout widget.

TBanner displays informational, warning, success, or error messages directly inside pages, forms, cards, or tables.

Named Constructors

Basic Usage

// Simple info banner
TBanner.info(
  message: 'A new software update is available for your system.',
)

// Rich banner with title, action, and dismiss button
TBanner.warning(
  title: 'Storage Limit Warning',
  message: 'You have used 85% of your available cloud storage.',
  action: TButton(
    text: 'Upgrade Plan',
    type: TButtonType.tonal,
    size: TButtonSize.xs,
    onTap: () => openUpgrade(),
  ),
  onDismiss: () => dismissWarning(),
)
Inheritance
Available extensions

Constructors

TBanner({Key? key, TBannerType type = TBannerType.info, String? title, String? message, Widget? child, dynamic icon, bool showIcon = true, TVariant variant = TVariant.tonal, Color? color, Widget? action, VoidCallback? onDismiss, EdgeInsetsGeometry padding = const EdgeInsets.symmetric(horizontal: 14.0, vertical: 10.0), EdgeInsetsGeometry? margin = const EdgeInsets.only(bottom: 12.0), BorderRadius? borderRadius, bool bordered = true})
Creates a banner widget.
const
TBanner.error({Key? key, String? title, String? message, Widget? child, dynamic icon, bool showIcon = true, TVariant variant = TVariant.tonal, Color? color, Widget? action, VoidCallback? onDismiss, EdgeInsetsGeometry padding = const EdgeInsets.symmetric(horizontal: 14.0, vertical: 10.0), EdgeInsetsGeometry? margin = const EdgeInsets.only(bottom: 12.0), BorderRadius? borderRadius, bool bordered = true})
Creates an error banner.
const
TBanner.info({Key? key, String? title, String? message, Widget? child, dynamic icon, bool showIcon = true, TVariant variant = TVariant.tonal, Color? color, Widget? action, VoidCallback? onDismiss, EdgeInsetsGeometry padding = const EdgeInsets.symmetric(horizontal: 14.0, vertical: 10.0), EdgeInsetsGeometry? margin = const EdgeInsets.only(bottom: 12.0), BorderRadius? borderRadius, bool bordered = true})
Creates an informational banner.
const
TBanner.neutral({Key? key, String? title, String? message, Widget? child, dynamic icon, bool showIcon = true, TVariant variant = TVariant.tonal, Color? color, Widget? action, VoidCallback? onDismiss, EdgeInsetsGeometry padding = const EdgeInsets.symmetric(horizontal: 14.0, vertical: 10.0), EdgeInsetsGeometry? margin = const EdgeInsets.only(bottom: 12.0), BorderRadius? borderRadius, bool bordered = true})
Creates a neutral status banner.
const
TBanner.success({Key? key, String? title, String? message, Widget? child, dynamic icon, bool showIcon = true, TVariant variant = TVariant.tonal, Color? color, Widget? action, VoidCallback? onDismiss, EdgeInsetsGeometry padding = const EdgeInsets.symmetric(horizontal: 14.0, vertical: 10.0), EdgeInsetsGeometry? margin = const EdgeInsets.only(bottom: 12.0), BorderRadius? borderRadius, bool bordered = true})
Creates a success banner.
const
TBanner.warning({Key? key, String? title, String? message, Widget? child, dynamic icon, bool showIcon = true, TVariant variant = TVariant.tonal, Color? color, Widget? action, VoidCallback? onDismiss, EdgeInsetsGeometry padding = const EdgeInsets.symmetric(horizontal: 14.0, vertical: 10.0), EdgeInsetsGeometry? margin = const EdgeInsets.only(bottom: 12.0), BorderRadius? borderRadius, bool bordered = true})
Creates a warning banner.
const

Properties

action → Widget?
Primary action widget (typically a TButton or action link).
final
bordered → bool
Whether to render an explicit border.
final
borderRadius → BorderRadius?
Border radius of the banner.
final
child → Widget?
Custom rich child widget replacing message.
final
color → Color?
Custom color override for the banner.
final
hashCode → int
The hash code for this object.
no setterinherited
icon → dynamic
Custom icon replacing the type's TBannerType.defaultIcon. Supports IconData, HugeIcon, or a custom Widget. Set to null with showIcon: false to hide.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
margin → EdgeInsetsGeometry?
Margin around the banner.
final
message → String?
Primary message text.
final
onDismiss → VoidCallback?
Dismiss callback. When provided, renders a close icon button on the top right.
final
padding → EdgeInsetsGeometry
Padding inside the banner.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showIcon → bool
Whether to display the leading icon. Defaults to true.
final
title → String?
Optional bold heading title.
final
type → TBannerType
The semantic type of the banner.
final
variant → TVariant
Visual styling variant. Defaults to TVariant.tonal.
final

Methods

box({double minW = 0.0, double minH = 0.0, double maxW = double.infinity, double maxH = double.infinity}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a ConstrainedBox to apply layout constraints.
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
center({bool when = true}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Center widget.
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
expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in an Expanded widget.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
padding([double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0]) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with flexible edge control.
paddingSymmetric({double h = 0.0, double v = 0.0}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with symmetric horizontal and vertical spacing.
size({double? w, double? h}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a SizedBox to apply fixed width and/or height.
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, {bool maintainState = false}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Visibility widget.
when(bool condition) → Widget

Available on Widget, provided by the WidgetX extension

Returns this widget if condition is true, otherwise returns SizedBox.shrink(). Usage: Text('Hello').when(isVisible)

Operators

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