rn-countdown-component v1.0.6
React Native Countdown Component
A light-weight countdown component for React Native
Getting Started
You can install the module via npm
.
npm install rn-countdown-component --save
Motivation
There is currently a lack in effective countdown timers for React Native applications. This module was designed for simplicity and to provide an easy way to implement a countdown component.
Basic Usage
A very simple and minimal example of how to set up a countdown which counts down from 10 seconds.
import React from 'react';
import Countdown from 'rn-countdown-component';
export default const CountdownApp (
<Countdown
seconds={10}
/>
);
Props
Name | Type | Default | Description |
---|---|---|---|
seconds | number | required | Length of countdown |
play | boolean | true | Countdown auto-start option |
format | object | ['hours', 'minutes', 'seconds'] | Format of time displayed on countdown component |
strokeColor | string | black | Color of stroke around the progress circle |
strokeWidth | number | 5 | The width in pixels of the stroke around the progress circle |
radius | number | 75 | Size of the progress circle |
onStart | function | null | Action to perform when the countdown has been started |
onPause | function | null | Action to perform when the countdown has been paused |
onFinish | function | null | Action to perform when the countdown has ended |
seconds
The seconds
prop is the only required one and must be a number
. This determines the time to count down from on the timer.
Valid values can be (and more):
'30'
-- 30 seconds'60'
-- 1 Minute'120'
-- 2 Minutes
play
Defines whether the countdown should start automatically or not. Defaults to true
.
format
The format of the time to display on the countdown component. Allowed types are, 'hours', 'minutes', and 'seconds'.
strokeColor
The strokeColor
prop determines the color of the stroke of the progress circle. A string
is the type.
Valid values can be (and more):
'black'
'#000'
strokeWidth
The strokeWidth
prop determines the width of the stroke of the progress circle. A number
is the type.
radius
The radius
prop determines the number of the stroke of the progress circle. A number
is the type.
onStart
The onStart
prop determines the action to perform when the countdown has started. A function
is the type.
onPause
The onPause
prop determines the action to perform when the countdown has been paused. A function
is the type.
onFinish
The onFinish
prop determines the action to perform when the countdown has finished. A function
is the type.
License
MIT