TBadge class

A badge widget that displays a small status or numerical indicator.

TBadge is usually used to wrap an icon or avatar to show notification counts, status dots, or other small alerts.

Basic Usage

TBadge(
  count: 5,
  child: Icon(Icons.notifications),
)

Status Dot

TBadge(
  dot: true,
  child: TAvatar(name: 'User'),
)
Inheritance

Constructors

TBadge({Key? key, required Widget child, int? count, String? label, bool dot = false, Color? color, Color? textColor, int maxCount = 99, bool hideZero = true, bool hidden = false, double? size})
Creates a badge.
const

Properties

child Widget
The widget to display the badge on.
final
color Color?
The background color of the badge.
final
count int?
The numerical value to display in the badge.
final
dot bool
Whether to display a small dot instead of text/count.
final
hashCode int
The hash code for this object.
no setterinherited
hidden bool
Whether the badge is hidden.
final
hideZero bool
Whether to hide the badge when count is 0.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label String?
A custom text label to display instead of count.
final
maxCount int
The maximum count to display before showing a '+' sign.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
size double?
The size of the badge (width/height).
final
textColor Color?
The text color of the badge.
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
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
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