custom-react-heatmap-grid

v0.8.66

React component for heatmap on grid layout

NPM

README

GitHub

Website

MIT

Latest version published 2 years ago

    npm install custom-react-heatmap-grid

We couldn't find any similar packages Browse all packages

Package Health Score

48 / 100

Popularity
Limited
Maintenance
Inactive
Security
No known security issues
Community
Sustainable

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (3)

Dependents: 0
GitHub Stars: 56
Forks: 30
Contributors: 10

The npm package custom-react-heatmap-grid receives a total of 3 downloads a week. As such, we scored custom-react-heatmap-grid popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package custom-react-heatmap-grid, we found that it has been starred 56 times, and that 0 other projects in the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

0.8.66

Indirect Vulnerabilities

0.8.66

License Risks

0.8.66

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like custom-react-heatmap-grid is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test custom-react-heatmap-grid

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 8
Merged PR: 45
Open PR: 5
Last Commit: 8 months ago

Further analysis of the maintenance status of custom-react-heatmap-grid based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for custom-react-heatmap-grid is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 10
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like custom-react-heatmap-grid is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 2 years
Dependencies: 1 Direct
Versions: 27
Install Size: 478 kB
Dist-tags: 1
# of Files: 27
Maintainers: 1
TS Typings: No

custom-react-heatmap-grid has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

react-heatmap-grid

A React component for heatmap in grid layout using div.

Live example here.

Screenshot

Installation

yarn add react-heatmap-grid

npm install react-heatmap-grid --save

Usage

Mandatory fields

Name	Type	Sample
`xLabels`	Array of string	`['1am', '2am', '3am']`
`yLabels`	Array of string	`['Sun', 'Mon']`
`data`	2D Array of numbers having `yLabels.length` rows and `xLabels.length` rows	`[[2,3,5][5,6,9]]`

const xLabels = new Array(24).fill(0).map((_, i) => `${i}`);
const yLabels = ['Sun', 'Mon', 'Tue'];
const data = new Array(yLabels.length)
  .fill(0)
  .map(() => new Array(xLabels.length).fill(0).map(() => Math.floor(Math.random() * 100)));

ReactDOM.render(
  <HeatMap
    xLabels={xLabels}
    yLabels={yLabels}
    data={data}
  />,
  document.getElementById('app')
);

Configuration

Name	Type	Description	Default Value
background	string	The base color for the heatmap	`"#329fff"`
height	number	Height of each cell of the heatmap in px	`30`
onClick	function	Adds an handler to cell click	`undefined`
squares	boolean	If set to `true` will render cells as square	`false`
xLabelWidth	number	Width of the x label area in pixel	`60`
yLabelWidth	number	Width of the y label area in pixel	`40`
yLabelTextAlign	string	Text alignment of the yLabels	`"right"`
xLabelsLocation	string	Location of y labels. It can be top or bottom	`"top"`
xLabelsVisibility	`[boolean]`	Array of bool conveying which x labels to display. For ex: `[true, false, true, false]` means the 1st and the 3rd labels will be displayed and the 2nd and 4th will be hidden
unit	string	Unit to display next to the value on hover
cellRender	function	Render custom content in cell	`() => null`
cellStyle	function	To set custom cell style. It is useful for using own colour scheme
title	function	To render custom title in each cell	`${value} ${unit}`

Example


const xLabels = new Array(24).fill(0).map((_, i) => `${i}`);

// Display only even labels
const xLabelsVisibility = new Array(24)
  .fill(0)
  .map((_, i) => (i % 2 === 0 ? true : false));

const yLabels = ["Sun", "Mon", "Tue"];
const data = new Array(yLabels.length)
  .fill(0)
  .map(() =>
    new Array(xLabels.length).fill(0).map(() => Math.floor(Math.random() * 100))
  );

ReactDOM.render(
  <HeatMap
    xLabels={xLabels}
    yLabels={yLabels}
    xLabelsLocation={"bottom"}
    xLabelsVisibility={xLabelsVisibility}
    xLabelWidth={50}
    data={data}
    squares
    onClick={(x, y) => alert(`Clicked ${x}, ${y}`)}
    cellStyle={(background, value, min, max, data, x, y) => ({
      background: `rgba(66, 86, 244, ${1 - (max - value) / (max - min)})`,
      fontSize: "11px",
    })}
    cellRender={value => value && `${value}%`}
    title={(value, unit) => `${value}`}
  />,
  document.getElementById("app")
);

For developers

New build

npm run build

Run dev server

npm run dev

Run test

npm run test