TimerCountDownBuilder class

A widget that builds itself based on a countdown timer.

This widget periodically updates its state based on the intervalDuration until the toDate is reached. It uses a StatefulWidget internally to manage the timer lifecycle without external dependencies.

Example Usage:

TimerCountDownBuilder(
  toDate: DateTime.now().add(const Duration(hours: 1)),
  builder: (context, state) {
    return Text(
      'Time remaining: ${state.timeToEndFormatted}',
      style: Theme.of(context).textTheme.headlineMedium,
    );
  },
)

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• TimerCountDownBuilder

Available extensions

• GBInputWrapperExtension

Constructors

TimerCountDownBuilder({Key? key, required Widget builder(BuildContext context, TimerCountDownState state), required DateTime toDate, Duration intervalDuration = const Duration(seconds: 1)})

Creates a TimerCountDownBuilder.

const

Properties

builder → Widget Function(BuildContext context, TimerCountDownState state)

The builder function that is called every time the timer ticks.

final

hashCode → int

The hash code for this object.

no setter, inherited

intervalDuration → Duration

The frequency at which the timer updates. Defaults to 1 second.

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

toDate → DateTime

The target date and time to count down to.

final

Methods

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<TimerCountDownBuilder>

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, 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

withGBInputWrapper({String? label, Widget? labelWidget, bool appendColonToLabel = true, TextStyle? labelStyle, String? errorText, bool hasError = false, List<InputFeedbackText>? feedback, WrapWidgetBuilder? innerBoxWrapper, BoxConstraints? constraints}) → Widget

Available on Widget, provided by the GBInputWrapperExtension extension

Operators

operator ==(Object other) → bool

The equality operator.

inherited