ParticipantsCounterBadgeOptions class

ParticipantsCounterBadgeOptions - Configuration options for the ParticipantsCounterBadge widget.

Properties:

  • participantsCount (int): The number of participants to display (required).
  • backgroundColor (Color): Background color for the badge (default is semi-transparent dark).
  • position (String): Corner position for the badge (topLeft, topRight, bottomLeft, bottomRight).
  • positionOverride (ParticipantsCounterBadgePositionOverride?): Fine-grained overrides for the badge offsets.
  • containerPadding / containerMargin: Padding and margin for the positioned container.
  • containerDecoration: Custom decoration for the positioned container.
  • badgePadding / badgeMargin: Padding and margin for the badge element.
  • badgeDecoration: Custom decoration for the badge.
  • badgeBorderRadius: Overrides the badge border radius.
  • textStyle: Custom text style for the count string.
  • iconColor: Color for the people icon.
  • iconSize: Size of the people icon.
  • textBuilder, badgeBuilder, containerBuilder, positionBuilder: Hooks to override portions of the widget tree.
  • showBadge: Controls visibility of the badge.
  • maintainState: Whether to keep state when the badge is hidden (defaults to false).

Constructors

ParticipantsCounterBadgeOptions.new({required int participantsCount, Color backgroundColor = const Color(0xCC2D3436), String position = 'topRight', ParticipantsCounterBadgePositionOverride? positionOverride, EdgeInsetsGeometry? containerPadding, EdgeInsetsGeometry? containerMargin, Decoration? containerDecoration, EdgeInsetsGeometry? badgePadding, EdgeInsetsGeometry? badgeMargin, Decoration? badgeDecoration, BorderRadiusGeometry? badgeBorderRadius, TextStyle? textStyle, Color? iconColor, double? iconSize, bool showBadge = true, bool maintainState = false, ParticipantsCounterBadgeContainerBuilder? containerBuilder, ParticipantsCounterBadgeBadgeBuilder? badgeBuilder, ParticipantsCounterBadgeTextBuilder? textBuilder, ParticipantsCounterBadgePositionBuilder? positionBuilder})
const

Properties

backgroundColor → Color
final
badgeBorderRadius → BorderRadiusGeometry?
final
badgeBuilder → ParticipantsCounterBadgeBadgeBuilder?
final
badgeDecoration → Decoration?
final
badgeMargin → EdgeInsetsGeometry?
final
badgePadding → EdgeInsetsGeometry?
final
containerBuilder → ParticipantsCounterBadgeContainerBuilder?
final
containerDecoration → Decoration?
final
containerMargin → EdgeInsetsGeometry?
final
containerPadding → EdgeInsetsGeometry?
final
hashCode → int
The hash code for this object.
no setterinherited
iconColor → Color?
final
iconSize → double?
final
maintainState → bool
final
participantsCount → int
final
position → String
final
positionBuilder → ParticipantsCounterBadgePositionBuilder?
final
positionOverride → ParticipantsCounterBadgePositionOverride?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showBadge → bool
final
textBuilder → ParticipantsCounterBadgeTextBuilder?
final
textStyle → TextStyle?
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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