# react-heatgrid

> React HeatGrid: Easily integrate customizable, interactive heatmaps into your React applications for data visualization.

Latest version **1.0.6** (published 2023-09-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-heatgrid
pnpm add react-heatgrid
yarn add react-heatgrid
bun add react-heatgrid
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2023-09-10 |
| First published | 2023-09-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=16 |
| Dependencies | 0 |
| Unpacked size | 22.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Arman Kazi |
| Maintainers | armankazi |
| Keywords | heatgrid, heatmap, contribution-chart, calendar-chart, contribution, react, typescript |

## Links

- npm: https://www.npmjs.com/package/react-heatgrid
- Repository: https://github.com/Amyx000/react-heatgrid
- Homepage: https://github.com/Amyx000/react-heatgrid#readme
- Issues: https://github.com/Amyx000/react-heatgrid/issues
- npm.io page: https://npm.io/package/react-heatgrid

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2023-09-10
- 1.0.5 — 2023-09-09
- 1.0.4 — 2023-09-09
- 1.0.3 — 2023-09-09
- 1.0.2 — 2023-09-09
- 1.0.1 — 2023-09-09
- 1.0.0 — 2023-09-09

## README

# React HeatGrid

React HeatGrid is a versatile and customizable heatmap component for React applications.

<img src="https://github.com/Amyx000/react-heatgrid/assets/104687128/81268e28-2c18-431b-8945-ce22295d4077" width="300" alt="HeatGrid Demo">

ToolTip when hover on each grid.

<img src="https://github.com/Amyx000/react-heatgrid/assets/104687128/60e4a279-e7b1-4274-9679-fa1b6fe70c3c" width="300" alt="HeatGrid Demo">

## Installation

You can install React HeatGrid via npm or yarn:

```bash
npm i react-heatgrid --save
```

## Usage

To use the `Calendar` component from the `react-heatgrid` package, you need to import it and pass the required props. Below is an example of how to use the `Calendar` component along with an explanation of its props:

```jsx
import React from 'react';
import { Calendar } from 'react-heatgrid';

const MyCalendar = () => {
  const calendarData = [
   { value: 9, day: '2023-08-23' },
    { value: 20, day: '2023-08-10' },
    { value: 49, day: '2023-07-17' },
    { value: 45, day: '2023-08-21' },
    { value: 7, day: '2023-07-23' },
    { value: 11, day: '2023-08-15' },
    { value: 28, day: '2023-08-26' },
    { value: 11, day: '2023-09-07' },
    { value: 27, day: '2023-09-08' },
    // you can add random day, skip a day and day can be date format like...
    { value: 27, day: new Date('2023-09-09') },
  ];

  const heatmapColors = ["#161b22","#0e4429","#006d32","#26a641","#39d353"];

  return (
    <div>
      <h1>My Calendar Heatmap</h1>
      <Calendar
        months={3}                 {/* Number of months to display */}
        data={calendarData}         {/* Array of data objects */}
        colors={heatmapColors}      {/* Array of heatmap colors */}
        tooltipLabel="activity"     {/* Tooltip label */}
      />
    </div>
  );
};

export default MyCalendar;

```

## Props Guide

| Prop               | Description                                                                                                                             | Default Value |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `months`           | The number of months to display in the calendar.                                                                                        | 3             |
| `gridSize`         | The size of each grid cell in the calendar.                                                                                             | "20px"        |
| `gap`              | The gap between grid cells in the calendar.                                                                                             | "2px"         |
| `data`             | An array of data objects representing each day in the calendar. Each object should have a 'value' (number) and 'day' (string) property. | Required      |
| `colors`           | An array of colors from low intensity to high. e.g ["#161b22","#0e4429","#006d32","#26a641","#39d353"]                                  | Required      |
| `fontSize`         | Size of text throughout the calendar.                                                                                                   | "12px"        |
| `fontColor`        | Color of the text                                                                                                                       | "black"       |
| `DisabledToolTip`  | Disable tooltips for grid cells.                                                                                                        | false         |
| `DisabledLegend`   | Disable the legend of chart                                                                                                             | false         |
| `placement`        | The placement of tooltips relative to the grid cell ("top" or "bottom").                                                                | "top"         |
| `tooltipBg`        | The background color of tooltips.                                                                                                       | "#303030"     |
| `tooltipTextColor` | The text color of tooltips.                                                                                                             | "white"       |
| `tooltipLabel`     | The label for the tooltip, which can be one of "activity", "contributions", or a custom string.                                         | "activity"    |
| `tooltipStyle`     | Additional CSS styles to apply to the tooltip. e.g {border:"1px solid red"}                                                             | None          |
| `dateFormat`       | Either "yyyy-mm-dd" (e.g 2023-01-31) or "WeekDay, Month Date, Year" (e.g Tue, Jan 31, 2023)                                             | "yyyy-mm-dd"  |

---
_Source: https://npm.io/package/react-heatgrid · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._