Giter VIP home page Giter VIP logo

react-timeprovider's Introduction

React TimeProvider

React components for safely accessing the current time.

NPM

Install

NPM:

npm install --save react-timeprovider

Yarn:

yarn add react-timeprovider

Usage

import * as React from 'react';

import { TimeProvider, GetTime } from 'react-timeprovider';

const WeekendStatus = ({ currentTime }) => {
  // Because we take currentTime as a prop, we now no longer depend
  // on the external system time in our render function. We are now
  // a pure function
  const dayOfWeek = new Date(currentTime).getDay();
  const isWeekend = [0, 6].includes(dayOfWeek);
  if (isWeekend) {
    return <p>It&apos;s the weekend!</p>;
  }
  return <p>It is not the weekend. :(</p>;
};

const App = () => (
  <TimeProvider>
    <h1>Is it the weekend?</h1>
    <GetTime>{({ currentTime }) => <WeekendStatus currentTime={currentTime} />}</GetTime>
  </TimeProvider>
);

export default App;

Documentation

<TimeProvider>

Props:

  • interval (number, default 500) - The number of milliseconds to wait before updating the time.

<GetTime>

Takes a function as children and passes an object containing currentTime to that function.

withTime

A HOC that will pass the prop currentTime to the wrapped component.

useTime

A Hook that will give you access to the currentTime.

import { useTime } from 'react-timeprovider';

const MyComponent = {
  const { currentTime } = useTime();

  // do something
};

createTimeProvider(getTime)

If you are writing tests and want to mock out the getTime function or if you don't like the default time representation you can create your own <TimeProvider> component.

const MockTimeProvider = createTimeProvider(() => '2018–04–06T12:30:00Z');

The getTime function will be passed any extra props that you set onto <TimeProvider>. This is useful if you want the time zone for example.

License

MIT © Everwise

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.