PrismBadge class
A small count or status pill that sits on top of another widget.
Counts above maxCount collapse to 99+, a zero count hides the badge
entirely (the common "no unread items" case), and the result is announced as
part of its parent rather than as a stray number.
PrismBadge(
count: unread,
child: Icon(Icons.notifications_outlined),
)
PrismBadge.dot(semantic: PrismSemantic.error, child: Avatar())
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- PrismBadge
Constructors
- PrismBadge({Key? key, required Widget child, int count = 0, int maxCount = 99, PrismSemantic semantic = PrismSemantic.error, bool showZero = false, Alignment alignment = Alignment.topRight, Offset? offset, String? label})
-
Creates a count badge.
const
- PrismBadge.dot({Key? key, required Widget child, PrismSemantic semantic = PrismSemantic.error, Alignment alignment = Alignment.topRight, Offset? offset, String? label})
-
Creates a small status dot with no count.
const
Properties
- alignment → Alignment
-
Where the badge sits relative to child.
final
- child → Widget
-
The widget the badge is attached to.
final
- count → int
-
The number to display. Ignored by PrismBadge.dot.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- label → String?
-
Accessibility label. Defaults to
"<count> new", or the semantic role name for a dot.final - maxCount → int
-
Counts above this render as
maxCount+.final - offset → Offset?
-
Extra offset applied to the badge.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semantic → PrismSemantic
-
Which semantic role colours the badge.
final
- showZero → bool
-
Whether a count of zero still renders. Defaults to hiding it.
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