lsvp-react-calendar-heatmap

v1.9.3

A calendar heatmap component built on SVG, inspired by Github's commit calendar graph. Forked by LSVP For more information about how to use this package see README

Latest version published 20 days ago

License: MIT

NPM

GitHub

Package Health Score

68 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

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

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.9.3	\|	07/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (11)

GitHub Stars: 1.2K
Forks: 156
Contributors: 20

Direct Usage Popularity

The npm package lsvp-react-calendar-heatmap receives a total of 11 downloads a week. As such, we scored lsvp-react-calendar-heatmap popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package lsvp-react-calendar-heatmap, we found that it has been starred 1,200 times.

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

Community

Sustainable

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

With more than 10 contributors for the lsvp-react-calendar-heatmap repository, this is possibly a sign for a growing and inviting community.

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

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

No Recent Commits

Open Issues: 33
Open PR: 20
Last Release: 20 days ago
Last Commit: 2 years ago

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

We found that lsvp-react-calendar-heatmap demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 2 months
Dependencies: 2 Direct
Versions: 4
Install Size: 150 kB
Dist-tags: 1
# of Files: 9
Maintainers: 1
TS Typings: No

lsvp-react-calendar-heatmap 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.

Readme

React Calendar Heatmap

A calendar heatmap component built on SVG, inspired by github's commit calendar graph. The component expands to size of container and is super configurable. Try it out on CodeSandbox.

Setup

Install the npm module with yarn or npm:

yarn add react-calendar-heatmap

Usage

Import the component:

import CalendarHeatmap from 'react-calendar-heatmap';

Import styles. You can directly import from the module, which requires a CSS loader:

import 'react-calendar-heatmap/dist/styles.css';

A CSS loader is included by default in create-react-app. If you don't have a CSS loader, you can simply copy the stylesheet into a file in your project and import it instead.

To show a basic heatmap from January 1st to April 1st:

Props

Name	Type	Description
`values`	Required, Array of Object	Required array of objects which each have a date property, which can be a Date object, parseable string, or millisecond timestamp. Example: `[{ date: '2016-01-01', count: 6 }]`
`startDate`	String, Number, or Date	Start of date range.
`endDate`	String, Number, or Date	End of date range - a Date object, parseable string, or millisecond timestamp.
`showMonthLabels`	Boolean	Toggle for removing month labels.
`showWeekdayLabels`	Boolean	Toggle for removing weekday labels.
`showOutOfRangeDays`	Boolean	Toggle display of extra days in week that are past endDate and before beginning of range.
`horizontal`	Boolean	Whether to orient horizontally or vertically. Can be used in combination with numDays/endDate to show just the current month.
`gutterSize`	Number	Size of gutters relative to squares.
`onClick`	Function	Callback to invoke when a square is clicked, e.g. `(value) => alert(value)`
`onMouseOver`	Function	Callback to invoke when mouse pointer is over a square, e.g. `(event, value) => console.log(event, value)`
`onMouseLeave`	Function	Callback to invoke when mouse pointer leaves a square, e.g. `(event, value) => console.log(event, value)`
`titleForValue`	Function	Function to determine each square's title attribute, for generating 3rd party hover tooltips (may also need to configure tooltipDataAttrs). Example: `(value) =>` Date is ${value.date}`
`tooltipDataAttrs`	Object or Function	Set data attributes for all squares, for generating 3rd party hover tooltips. Either an object like `{ 'data-tooltip': 'tooltip' }` or a function like `(value) => { return { 'data-tooltip': 'Tooltip: ' + value } }`
`classForValue`	Function	Callback for determining CSS class to apply to each value, e.g. `(value) => (value.count > 0 ? 'blue' : 'white')`.
`monthLabels`	Array of String	An array with 12 strings representing the text from January to December, e.g. `['01', '02', ..., '12']`
`weekdayLabels`	Array of String	An array with 7 strings representing the text from Sunday to Saturday
`transformDayElement`	Function	A function to further transform generated svg element for a single day. Can be used to attach event handlers, add tooltips and more. Example: `(element, value, index) => React.cloneElement(element, { title: value.date })`.

Configuring colors

To use the color scale shown in the live demo based on the github contribution graph, you can set the classForValue prop, a function that determines which CSS class to apply to each value:

 {
    if (!value) {
      return 'color-empty';
    }
    return `color-scale-${value.count}`;
  }}
/&gt;

Then you use CSS to set colors for each class:

.react-calendar-heatmap .color-scale-1 { fill: #d6e685; }
.react-calendar-heatmap .color-scale-2 { fill: #8cc665; }
.react-calendar-heatmap .color-scale-3 { fill: #44a340; }
.react-calendar-heatmap .color-scale-4 { fill: #1e6823; }

Contributing

Take a look at CONTRIBUTING.md to see how to develop on react-calendar-heatmap.

License

lsvp-react-calendar-heatmap dependencies

memoize-one prop-types

FAQs

What is lsvp-react-calendar-heatmap?

A calendar heatmap component built on SVG, inspired by Github's commit calendar graph. Forked by LSVP. Visit Snyk Advisor to see a full health score report for lsvp-react-calendar-heatmap, including popularity, security, maintenance & community analysis.

Is lsvp-react-calendar-heatmap popular?

The npm package lsvp-react-calendar-heatmap receives a total of 11 weekly downloads. As such, lsvp-react-calendar-heatmap popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is lsvp-react-calendar-heatmap well maintained?

We found indications that lsvp-react-calendar-heatmap maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is lsvp-react-calendar-heatmap safe to use?

The npm package lsvp-react-calendar-heatmap was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 9 August-2024, at 22:28 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

lsvp-react-calendar-heatmap

A calendar heatmap component built on SVG, inspired by Github's commit calendar graph. Forked by LSVP For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (11)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

React Calendar Heatmap

Setup

Usage

Props

Configuring colors

Contributing

License

lsvp-react-calendar-heatmap dependencies

lsvp-react-calendar-heatmap development dependencies

FAQs

What is lsvp-react-calendar-heatmap?

Is lsvp-react-calendar-heatmap popular?

Is lsvp-react-calendar-heatmap well maintained?

Is lsvp-react-calendar-heatmap safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (11)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

React Calendar Heatmap

Setup

Usage

Props

Configuring colors

Contributing

License

lsvp-react-calendar-heatmap dependencies

lsvp-react-calendar-heatmap development dependencies

FAQs

What is lsvp-react-calendar-heatmap?

Is lsvp-react-calendar-heatmap popular?

Is lsvp-react-calendar-heatmap well maintained?

Is lsvp-react-calendar-heatmap safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues