SheenBadge class

A count or a dot at the top-end corner of child, in red with white figures, as iOS badges are: unread messages, items in a cart.

A count of 0 hides the badge; past max it reads "99+". Screen readers hear semanticLabel (the count when null) as the value of child.

SheenBadge(count: unread, child: SheenIconButton(icon: SheenIcons.bell, semanticLabel: 'Notifications', onTap: open))
Inheritance

Constructors

SheenBadge({Key? key, required Widget child, required int count, int max = 99, String? semanticLabel})
A count badge on child.
const
SheenBadge.dot({Key? key, required Widget child, String? semanticLabel})
A dot badge on child, for "something new" without a number.
const

Properties

child → Widget
What the badge sits on.
final
count → int
The number shown; 0 or less hides the badge.
final
dot → bool
Whether the badge is a dot without a number.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
max → int
The largest number shown in full; more reads "max+".
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
semanticLabel → String?
What a screen reader adds to child; the count when null.
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

Constants

color → const Color
The badge colour.