TimeCircularCountdown class

Time unit CircularCountdown.

Refreshes itself every unit tick.

Note: If you want full control on the timer (play, pause, etc), you can use the timer_controller library with the CircularCountdown. You can find how to integrate it in the example app.

Inheritance

Constructors

TimeCircularCountdown({required CountdownUnit unit, int countdownTotal = 1, bool shouldDowngradeUnit = true, CountdownCallback? onUpdated, VoidCallback? onFinished, CountdownCallback? onCanceled, double? diameter, Color countdownTotalColor = Colors.white30, Color countdownRemainingColor = Colors.white, Color? countdownCurrentColor, double gapFactor = 6, double? strokeWidth, TextStyle? textStyle, bool isClockwise = true, bool? repeat, Key? key})
Creates a TimeCircularCountdown.
const

Properties

countdownCurrentColor → Color?
The color to use when painting the current unit.
final
countdownRemainingColor → Color
The color to use when painting remaining units.
final
countdownTotal → int
The amount of unit to count down.
final
countdownTotalColor → Color
The color to use when painting passed units.
final
diameter → double?
The outer diameter of the circular countdown widget.
final
gapFactor → double
The part of the circle that will be gap. (1/gapFactor)
final
hashCode → int
The hash code for this object.
no setterinherited
isClockwise → bool
Whether the countdown is drawn clockwise or not.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onCanceled → CountdownCallback?
Callback to call when countdown has canceled before the end.
final
onFinished → VoidCallback?
Callback to call when countdown has finished.
final
onUpdated → CountdownCallback?
Callback to call when countdown has updated.
final
repeat → bool?
Whether the countdown should restart when finished or not.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shouldDowngradeUnit → bool
If the countdown should display the unit below when less than a unit left.
final
strokeWidth → double?
The thickness of the circle in logical pixels.
final
textStyle → TextStyle?
The TextStyle to use to display the countdownRemaining value in the center of the widget.
final
unit → CountdownUnit
The time unit.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _TimeCircularCountdownState
Creates the mutable state for this widget at a given location in the tree.
override
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}) → 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