react-interval-timer

1.0.5 • Public • Published

React Interval Timer

Build Status MIT License

React Component Wrapper for setTimeout and setInterval.

npm install --save react-interval-timer

Usage examples

import IntervalTimer from 'react-interval-timer';
 
class App extends React.Component {
 
    render() {
        return (
            <div>
                <IntervalTimer
                    timeout={1000}
                    callback={()=>{console.log("Your function")}}
                    enabled={true}
                    repeat={true}
                />
            </div>
        )
    }
}
 
export default App;

Run the example app

git clone https://github.com/m-ueta/react-interval-timer.git
cd react-interval-timer
npm install
npm start

then open http://localhost:3000

Options

Props

IntervalTimer.propTypes = {
    timeout: PropTypes.number,
    enabled: PropTypes.bool,
    callback: PropTypes.func,
    repeat: PropTypes.bool
};
IntervalTimer.defaultProps = {
    timeout: 1000,
    enabled: false,
    callback: () => {
        console.log("You need set your callback function for IntervalTimer")
    },
    repeat: true
};

timeout

setTimeout setInterval time

callback

callback function

enabled

Switch timer enable or disable

repeat

switch using setInterval or setTimeout

License

MIT

Package Sidebar

Install

npm i react-interval-timer

Weekly Downloads

51

Version

1.0.5

License

MIT

Unpacked Size

12.8 kB

Total Files

7

Last publish

Collaborators

  • m-ueta