almanac
v0.0.5
Published
HTML5 calendar element. Not ready for production.
Downloads
5
Maintainers
Readme
Almanac
In early development
HTML5 calendar element
Usage
Link almanaque.js
from your html file
<script src="path/to/almanaque.js"></script>
or require it with Browserify:
var Almanac = require('path/to/almanac')
almanac.createCalendar( target, options )
Create an almanac in/at target
with passed options.
Parameters:
- target HTML element: Element to replace, or embed in the almanac
- options Object
Example:
// get a HTML element
var elem = document.getElementById( 'myCalendar' );
// or create one and insert when you want
// var elem = document.createElement( 'div' );
// elem.setAttribute( 'name', 'myCalendarName')
// then create a calendar
var calendar = almanac.createCalendar( elem, {
multi: true,
showMonths: 2
});
options
:
name
: Setsname
as input namemulti
: Sets single (input[type="radio"]) or multiple (input[type="checkbox"]) day selection.showMonths
: Months to show in calendar at onceid
: Setid
as almanac element idclasses
: Addclasses
to almanac element. Separated by spacesmonthNames
: List of month names. English names by defaultfirstDay
: A day from first month to show in almanactitle
: title for header calendarnoHeader
: Don't show almanac headerbinding
: function to launch when day is clicked. Signature: checked (bool), day data (object)start
: first enabled day (format: YYYYMMDD)end
: last enabled day (format: YYYYMMDD)
Tests
To run tests (mocha & chai):
npm install && npm test
© 2014 jacoborus
Released under MIT License