vue-calendar-heatmap



A lightweight calendar heatmap Vuejs component built on SVG, inspired by github's contribution calendar graph. With vertical mode, tooltip powered by v-tooltip.

Table of contents

- Installation
- Usage

Installation

``
npm install --save vue-calendar-heatmap
`

Default import

Global Install:

`javascript
import Vue from 'vue'
import VueCalendarHeatmap from 'vue-calendar-heatmap'

Vue.use(VueCalendarHeatmap)
`

Use specific components:

`javascript
import Vue from 'vue'
import { CalendarHeatmap } from 'vue-calendar-heatmap'

Vue.component('calendarHeatmap', CalendarHeatmap)
`

or in a parent components .vue file

`html

`

⚠️ A css file is included when importing the package. You may have to setup your bundler to embed the css in your page.

Distribution import

Global Install:

`javascript
import 'vue-calendar-heatmap/dist/vue-calendar-heatmap.css'
import VueCalendarHeatmap from 'vue-calendar-heatmap/dist/vue-calendar-heatmap.common'

Vue.use(VueCalendarHeatmap)
`

Use specific components:

`javascript
import 'vue-calendar-heatmap/dist/vue-calendar-heatmap.css'
import { CalendarHeatmap } from 'vue-calendar-heatmap/dist/vue-calendar-heatmap.common'

Vue.component('calendarHeatmap', CalendarHeatmap)
`

⚠️ You may have to setup your bundler to embed the css file in your page.

Browser

`html




`

The plugin should be auto-installed. If not, you can install it manually with the instructions below.

Install all the components:

`javascript
Vue.use(VueCalendarHeatmap)
`

Use specific components:

`javascript
Vue.component('calendarHeatmap', VueCalendarHeatmap.CalendarHeatmap)
`

Usage

Availables props

$3


Array of objects with date and count keys. date values can be a date parseable string, a millisecond timestamp, or a Date object. count value should be a number.
` html

`

$3

Can be a date parseable string, a millisecond timestamp, or a Date object. The calendar will start automatically one year before this date.
` html

`

$3

A Array of 5 strings which represents the colors of the progression. The color at colorRange[0] will always represent the values for a count: 0. The others are automatically distributed over the maximum value of count, unless you specify max props. Default value is equal to the example.
` html

`

$3

Any number which should be the max color.
` html

`

$3

Boolean for enabble/disable tooltip on square hover. true by default.
` html

`

$3

String representing heatmap's unit of measure. His value is "contributions" by default.
` html

`

$3

Boolean to switch to vertical mode. false by default.
` html

``

License

MIT