npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-heatmap

v1.0.6

Published

React Heatmap

Downloads

472

Readme

React Heatmap

A very simple port of heatmap.js for React. The idea behind this component is to be able to display a heatmap over any type of content (image, div, components ...). By default, the heatmap will always take all available width and height of its container.

Demo & Examples

Live demo: JonathanWi.github.io/react-heatmap

To build the examples locally, run:

npm install
npm start

Then open localhost:8000 in a browser.

Installation

The easiest way to use react-heatmap is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

You can also use the standalone build by including dist/react-heatmap.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

npm install react-heatmap --save

Usage

This component is pretty straightforward and only expecting 2 simple parameters (max and data; if you're unfamiliar with these, take a look at the heatmap.js documentation);

var ReactHeatmap = require('react-heatmap');

let data = [{ x: 10, y: 15, value: 5}, { x: 50, y: 50, value: 2}, ...];

<ReactHeatmap max={5} data={data} />

Properties

General component description.

Props

Prop | Type | Default | Required | Description --------------------- | -------- | ------------------------- | -------- | ----------- max|int|5|No|Maximum value for intensity data|array|[]|No|Heatmap array of dots unit|string|percent|No|Can be either percent or pixels. If percent, a x value like 26 is considered 26% of the container from the top left

Development (src, lib and the build process)

NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run npm start. If you just want to watch changes to src and rebuild lib, run npm run watch (this is useful if you are working with npm link).

License

MIT License Copyright (c) 2016 Jonathan Widawski.