Last updated:
0 purchases
flexi timer
Flexi Timer #
A timer package primarily focus on flexibility with controller.
Getting Started #
Add flexi_timer under dependencies in pubspec.yaml:
dependencies:
flexi_timer:
copied to clipboard
Run the following command:
$ flutter pub get
copied to clipboard
Import the package:
import 'package:flexi_timer/flexi_timer.dart';
copied to clipboard
Usage #
Users can either start the timer automatically or via controller. The following will guide you through the basic of the two approaches.
Initialise controller #
Firstly, initialise the controller and pass the controller like so:
FlexiTimerController _timerController = FlexiTimerController();
copied to clipboard
FlexiTimer(
controller: _timerController,
timerFormat: TimerTextFormat.ms,
...
);
copied to clipboard
First approach: Manually start timer via controller #
Call the startCountdown() function and pass the duration
_timerController.startCountdown(Duration(seconds: 120));
copied to clipboard
Second approach: Auto-start timer by passing duration to FlexiTimer widget #
Specify the duration in the FlexiTimer widget
FlexiTimer(
controller: _timerController,
timerFormat: TimerTextFormat.ms,
duration: const Duration(seconds: 5),
...
);
copied to clipboard
Stop timer via controller #
Stop the timer by calling stop() function
_timerController.stop();
copied to clipboard
Brief overview #
FlexiTimer(
controller: _timerController,
duration: const Duration(seconds: 5),
timerFormat: TimerTextFormat.ms,
onComplete: () {
print('Timer completed!');
},
textStyle: const TextStyle(
color: Colors.blue,
fontSize: 60,
),
isDiplayIcon: true,
iconPosition: IconPosition.prefix,
icon: const Icon(
Icons.timer,
),
iconPadding: 10,
iconColor: Colors.blue,
iconSize: 50,
);
copied to clipboard
Parameters #
Name
Type
Default Value
Mandatory
Description
onComplete
VoidCallback?
null
N
This callback will be executed after timed out
textStyle
TextStyle
TextStyle (color: Colors.black, fontSize: 24)
N
This param allows users to style the text of timer
timerFormat
TimerTextFormat
TimerTextFormat.s
N
This param allows users to change the format of timer with the following options: • TimerTextFormat.Hms • TimerTextFormat.ms • TimerTextFormat.s
icon
Icon?
Icon(Icons.timer, size: widget.iconSize, color: widget.iconColor)
N
This param allows users to personalise the Icon widget
iconPadding
double
10
N
This param allows users to change the padding between the icon and the timer text
iconSize
double?
24
N
This param allows users to change the default icon size
iconColor
Color?
Colors.black
N
This param allows users to change the default icon color
iconPosition
IconPosition
IconPosition.suffix
N
This param allows users to change the position of icon with the following options: • IconPosition.prefix • IconPosition.suffix
isDisplayIcon
bool
false
N
This param allows users to control the visibility of icon
controller
FlexiTimerController
null
Y
This param allows users to control the behaviour of timer
duration
Duration?
null
N
This param allows user to personalise the duration of timer
Demo #
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
There are no reviews.