# dayyearcalendar

> For all the days in a year, this calendar shows each as a cell of a grid with a color representing the day's value. This calendar is inspired by GitHub's "contributions calendar"

Latest version **1.1.0** (published 2015-12-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install dayyearcalendar
pnpm add dayyearcalendar
yarn add dayyearcalendar
bun add dayyearcalendar
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2015-12-02 |
| First published | 2015-12-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Jordan O'Leary |
| Maintainers | nestfall |
| Keywords | calendar, days, github, year |

## Links

- npm: https://www.npmjs.com/package/dayyearcalendar
- Repository: https://github.com/jdoleary/dayYearCalendar
- Homepage: https://github.com/jdoleary/dayYearCalendar#readme
- Issues: https://github.com/jdoleary/dayYearCalendar/issues
- npm.io page: https://npm.io/package/dayyearcalendar

## Recent versions

- 1.1.0 (latest) — 2015-12-02
- 1.0.0 — 2015-12-02

## README

# dayYearCalendar
Calendar shows all days in a year at a glance.  Inspired by GitHub's "Contribution's Calendar".
![Day Year Calendar](/preview.PNG?raw=true "Screenshot")

# Usage
To use DayYearCalendar, simply import 
  * app/dist/DayYearCalendar.min.js
  * app/dist/DayYearCalendar.css
  * and jQuery
  
The following javascript will create an instance of DayYearCalendar, add a little data to it, and render it to the HTML body. See [Plain Import](/app/plainImport.html)
```javascript
    var dayYearCal = new DayYearCalendar();
    dayYearCal.renderHTML($('body'));

    var dateInformation = [
      {date:1448946000000,value:4},
      {date:1448686800000,value:3}
    ];
    dayYearCal.addColorData(dateInformation);
```

DayYearCalendar can also be required and built, see [Browserify Example](/app/src/js/usageExample.js).

If you have questions for how to compile the project or use it in your own, feel free to email me at jdoleary[at]gmail.com

# Build
At project root run
`npm install`
then
`npm run build`
Then import 
  * app/dist/UsageExample.js
  * app/dist/DayYearCalendar.css
  * and jQuery
Open the html and you should see the calendar in all it's glory!

---
_Source: https://npm.io/package/dayyearcalendar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._