Heat.js

🌞 A lightweight JavaScript library that generates customizable heat maps and charts to visualize date-based activity and trends.

v1.8.3

What features does Heat.js have?

Zero-dependencies and extremely lightweight!
Full API available via public functions.
Fully styled in CSS/SASS, fully responsive, and compatible with the Bootstrap library.
Full CSS theme support (using :root variables).
3 views supported: Map Chart and Statistics!
Fully configurable per DOM element.
Toggling colors on/off support.
Export all data to CSV.
40 language translations available!
Trend types allows data to be split up and viewed separately.
Customizable tooltips.
7 themes available (for dark and light mode).

What browsers are supported?

All modern browsers (such as Google Chrome, FireFox, and Opera) are fully supported.

What languages are supported?

ar Arabic
bn Bengali
bg Bulgarian
zh Chinese (simplified)
da Danish
nl Dutch
en English (default)
et Estonian
fa Farsi
fi Finnish
fr French
gl Galician
ka Georgian
de German
el Greek
he Hebrew
hi Hindi
hu Hungarian
is Icelandic
id Indonesian
ga Irish
it Italian
ja Japanese
ko Korean
lv Latvian
lt Lithuanian
lb Luxembourgish
ms Malay
ne Nepali
no Norwegian
pl Polish
pt Portuguese
ro Romanian
sk Slovak
sl Slovenian
es Spanish
sv Swedish
th Thai
tr Turkish
uk Ukrainian

What are the most recent changes?

To see a list of all the most recent changes, click here.

How do I get started?

To get started using Heat.js, do the following steps:

1. Prerequisites:

Make sure you include the "DOCTYPE html" tag at the top of your HTML, as follows:

<!DOCTYPE html>

2. Include Files:

<link rel="stylesheet" href="dist/heat.js.css">
<script src="dist/heat.js"></script>

3. DOM Element Binding:

<div id="heat-map" data-heat-options="{ 'showDayNames': true }">
    Your HTML.
</div>

To see a list of all the available binding options you can use for "data-heat-options", click here.

To see a list of all the available custom triggers you can use for "data-heat-options", click here.

5. Adding Dates:

Now, you can add/remove dates, which will update the heat map automatically!

<script>
  var newDateObject = new Date();

  $heat.addDate( "heat-map", newDateObject, "Trend Type 1", true );
  $heat.removeDate( "heat-map", newDateObject, "Trend Type 1", true );
</script>

5. Finishing Up:

That's it! Nice and simple. Please refer to the code if you need more help (fully documented).

How do I go about customizing Heat.js?

To customize, and get more out of Heat.js, please read through the following documentation.

1. Public Functions:

To see a list of all the public functions available, click here.

2. Configuration:

Configuration options allow you to customize how Heat.js will function. You can set them as follows:

<script> 
  $heat.setConfiguration( {
      safeMode: false
  } );
</script>

To see a list of all the available configuration options you can use, click here.

About

🌞 A lightweight JavaScript library that generates customizable heat maps, charts, and statistics to visualize date-based activity and trends.

https://www.william-troup.com/heat-js

MIT License

Languages

Language:JavaScript 65.4%Language:SCSS 20.2%Language:HTML 13.7%Language:CSS 0.6%Language:Shell 0.1%