react-native-square-timer
TypeScript icon, indicating that this package has built-in type declarations

0.1.2 • Public • Published

react-native-square-timer

Square Timer component for React Native

follow on Twitter

NPM

  • stable release version: version
  • package downloads: downloads
  • MIT license

Show Cases

IOS Android

Getting Started

Installation

npm i react-native-square-timer --save

Basic Usage

  • Install react-native-cli first
$ npm install -g react-native-cli

Note: GUIDE

  • Initialization of a react-native project
$ react-native init AwesomeProject
  • Then, edit AwesomeProject/App.js, like this:
import * as React from 'react';
import { View } from 'react-native';
import SquareTimer from 'react-native-square-timer';

type Props = {}
export default class App extends React.Component<Props> {
    render() {
        return (
            <View 
                style={{
                    flex: 1,
                    justifyContent: 'center',
                    alignItems: 'center',
                    backgroundColor: 'white'
                }}
            >
            <SquareTimer
                min={2}
                onTimeElapsed={() => {
                    console.log('Timer Finished!');
                }}
            />
        </View>
        );
    }
}

Props

parameter type required description default
min number yes Time in minutes
length number no The length of square as height & width of the component 200
borderWidth number no The border width of the square 20
elapsedIndicatorColor string no The elapsed time indicator color "#818181"
remainingIndicatorColor string no The remaining time indicator color colorful
innerSquareColor string no The color of inner sqaure "#ffffff"
style object no To style the timer default
textStyle object no To override the text style default
onTimeElapsed function no Callback for the timer end () => {}

To run example

cd example
npm install
react-native run-android (For android)
react-native run-ios (For ios)

In case of any issue follow the GUIDE.

Package Sidebar

Install

npm i react-native-square-timer

Weekly Downloads

2

Version

0.1.2

License

MIT

Unpacked Size

18.5 kB

Total Files

6

Last publish

Collaborators

  • meharbhutta