@quiqupltd/react-time-provider NPM

React `TimeProvider` and `TimeConsumer`

A configurable timer utility to pass time props to your components via Context API at a set interval.

Install

yarn add @quiqupltd/react-time-provider

Use

import React, { Component } from 'react'
import TimeProvider from '@quiqupltd/react-time-provider'

class App extends Component {
  render() {
    return (
      <TimeProvider isTimerRunning={true}>
        <Routes />
      </TimeProvider>
    )
  }
}

Then consume in your app

import { TimeConsumer } from '@quiqupltd/react-time-provider'

const RemainingTime = () => {
  return (
    <TimeConsumer>
      { ({now}) => <ComponentThatNeedsTimer now={now}/> }
    </TimeConsumer>
  )
}

`TimeProvider`

prop	Type	Description	Default
now	Number	UNIX timestamp ie. `1523444679818`	`Date.now()`
isTimerRunning	Boolean	`true` or `false` starts or stops the timer	`false`
timerInterval	Number	interval length in milliseconds	1000