simple_timer

SimpleTimer

A Simple Timer Widget that displays the timer progress with various customizable options.

Installing

To Start using this library include simple_timer as a dependency in your puspec.yaml file. Make sure to include the latest version.

Pub link: https://pub.dev/packages/simple_timer

Usage

To use the widget, import the package in your project

import 'package:simple_timer/simple_timer.dart';

The timer can be controlled in two ways:

• Using a TimerController (preferred) - The TimerController is a convenience wrapper (subclass) of an AnimationController and needs a TickerProvider, so be sure to extend a TickerProvider in your class. Declare and instantiate your timer controller like below:

  // declaration
  TimerController _timerController;
  
  // instantiation
  _timerController = TimerController(this);
  

  Note: Remember to dispose the TimerController

  and set the controller property to the TimerController object like below:

  Container(
      child: SimpleTimer(
          controller: _timerController,
          duration: Duration(seconds: 10),
      )
  )
  

  TimerController methods:

  Method	Description
  start	Starts the timer e.g. (_timerController.start())
  pause	Pauses the timer e.g. (_timerController.pause())
  reset	Resets the timer e.g. (_timerController.reset())
  restart	Restarts the timer e.g. (_timerController.restart())
  add	Increases time left by the specified duration i.e. allows more time e.g. (_timerController.add(Duration(seconds: 10)))
  subtract	Decreases time left by the specified duration i.e. reduces the time e.g. (_timerController.subtract(Duration(seconds: 10)))

• Setting the Status - The timer can also be controler by passing a TimerStatus value to the status property; like below:

  Container(
      child: SimpleTimer(
          status: TimerStatus.start,
          duration: Duration(seconds: 10),
      )
  )
  

Note: The SimpleTimer widget uses its parent size.

Customizable Options

There are various customizable options provided by the SimpleTimer widget, see below:

Pub link: https://pub.dev/packages/simple_timer

Demo - Controlling the Timer Status

Demo - Customizable options