react-heat-calendar

React Heat Calendar

Like a Github's contribution calendar.

Installation

Install the npm module:

yarn add react-heat-calendar
# Or
npm install react-heat-calendar

Usage

Import the component:

import HeatCalendar from 'react-heat-calendar';

<HeatCalendar
  beginDate={new Date('2016-12-01')} // optional
  endDate={new Date('2017-01-31')}   // optional
  dateField="date"                   // optional
  data={[
    { date: '2016-12-02', someAttr: "foo" },
    { date: '2016-12-03', someAttr: "bar" },
    { date: '2016-12-03', someAttr: "baz" },
    // ...and so on
  ]}
/>

Defaults

property	value
beginDate	start date of minimum month in the data
endDate	end date of maximum month in the data
dateField	"date"

Development

• Development server npm start.
• Continuously run tests on file changes npm run watch-test;
• Run tests: npm test;
• Build npm run build;