Reckoning NPM | npm.io

Reckoning

🗓 A Legendary Javascript Calendar Library

Check out the demo page for the current feature-set

What is Reckoning?

Reckoning is a data-driven time visualization library. That's a very fancy way of saying a 'calendar'.

Reckoning is currently built in native (es5) JS and has 'vanilla views', but there is a heavy leaning towards integration with Mithril.

What's the point?

A lot of calendar libraries are either document-driven (i.e. a jQuery plugin) or are difficult to style (i.e. ... a jQuery plugin). The goal for this project is to produce a highly-reusable calendar library that can be used in a multitude of ways while always looking and feeling amazing. (But don't worry we'll probably end up making a jQuery plugin for it eventually.)

The goal is to make Reckoning a base module for other calendar implimentations, rather than trying to pack everything into the core.

Key Features

Dynamic range mapping, display & checking
Easy theme creation & styling hooks
Built-in date parsing & formatting
External parsing & formatting API (easy moment.js integration)
Simple keyboard/click API for calendar interactions
Semantic table markup
Accessiblity by default
Localization by default (where supported)

Using Reckoning as a Utility

Maybe you don't want to generate an entire calendar and you just want to map a range using Reckoning's API? Cool dude - I've got you there. Use Reckoning methods directly.

Available non-instance methods:

Reckoning.getDateKey(String<YYYY-MM-DD> | Date)
Reckoning.getMonth(String<YYYY-MM-DD> | Date)
Reckoning.getDay(String<YYYY-MM-DD> | Date)
Reckoning.mapRange(<DateRange>)
Reckoning.between(String<YYYY-MM-DD> | Date from, String<YYYY-MM-DD> | Date to)
Reckoning.locale(String | Array<String>)
Reckoning.format(String<YYYY-MM-DD> | Date)
Reckoning.parse(String<YYYY-MM-DD> | Date)

e.g.

// explictly map today, tomorrow, and every weekend
var partyTime = Reckoning.mapRange({ dates: [today, tomrorow], everyWeekday: [0,6] });
partyTime.inRange(today);
// true - time to party

Using Reckoning as a Constructor

Reckoning acts as a constructor and spits out views and simple API endpoints to modify the view on-the-fly.

var today = new Date();
var tomorrow = new Date(today.getFullYear(), today.getMonth(), today.getDate() + 1);

var todayCal = new Reckoning({
  calendar: {
    today: today
  },
  ranges: {
    // intialize with a 'selected' range
    selected: {
      dates: today
    }
  }
});

// add tomorrow as another selected date
todayCal.ranges.selected.setDate(tomorrow);

// add another range to highlight 'today'
todayCal.ranges.today = todayCal.mapRange({ name: 'today', dates: today });

// add a range between two dates
var demoDateFrom = new Date(today);
var demoDateTo = new Date(today);

demoDateFrom.setDate(3);
demoDateTo.setDate(7);

todayCal.ranges.demo = todayCal.mapRange({
  name: 'demo',
  fromDate: demoDateFrom,
  toDate: demoDateTo
});

// add repeating months/dates/weekdays
todayCal.ranges.weekend = todayCal.mapRange({
  name: 'weekend',
  everyWeekday: [0,6]
});

And oh yeah, you know all those ranges you've created? There's a simple method to check if any given date is within one of those ranges...

todayCal.ranges.today.inRange(today);
// true
todayCal.ranges.today.inRange(tomorrow);
// false

Constructor Profile

Reckoning currently accepts the following options, with defaults pre-defined for each (see Reckoning.prototype.defaults).

{
  locale: [String | Array<String>],

  ranges: [Array<DateRange> | Object<DateRange>], // discussed below

  calendar: {
    controls: [Boolean | Object], // controls object below
    today: [String<YYYY-MM-DD> | Date],
    dayView: [Function],
    numberOfMonths: [Number],
    startWeekOnDay: [Number],
    startDate: [String<YYYY-MM-DD> | Date],
    year: [Number],
    month: [Number],
    onDayClick: [Function],
    onDayKeydown: [Function]
  },

  string: {
    weekday: [String], // narrow/short/long
    month: [String], // narrow/short/long
    year: [String], // numeric/2-digit
    day: [String] // numeric/2-digit
  },

  controls: {
    previous: [Boolean | String | Function],
    reset: [Boolean | String | Function],
    next: [Boolean | String | Function]
  }
}

Date Range Profile

{
  name: String,
  id: [String],
  dates: [String<YYYY-MM-DD> | Array<String<YYYYMMDD>>],
  toDate: [String<YYYY-MM-DD> | Date],
  fromDate: [String<YYYY-MM-DD> | Date],
  fixedBetween: [Boolean],
  everyDate: [Number | Array<Number>],
  everyWeekday: [String | Number | Array<String | Number>],
  everyMonth: [String | Number | Array<String | Number>]
}

DateRanges can be mapped when initializing a Reckoning instance, or afterwards using Reckoning.mapRange. The id parameter is used in order for multiple ranges to share the same name for styling or other purposes, and can be randomly generated if you desire.

The name parameter is the only required property, and it's not really required. When intializing a Reckoning with the ranges object, the name is automatically assigned by the DateRange's key if no name value is provided. (In this case, the key is transformed from camelCase to kebab-case since the name is used for css styles). If initializing with an array, or via mapRange, a name is required.

Creating a Calendar

With any Reckoning instance (i.e. var foo = new Reckoning), you can use the [instance].createCalendar([Boolean | Object]) factory to generate a new calendar object. This allows you to easily share multiple calendars with the same locale, formatting/parsing settings, and ranges. It also allows you to handle onDayClick uniquely across different calendar views, etc.

Note that this is not available from the main Reckoning instance and if you try to call it directly from Reckoning.prototype.createCalendar won't work.

More to come!

More features are planned (and some already have defined defaults). When they are fully functional the profile above will be updated.

Using with Mithril

Mithril expects every component to have a controller and a view (at least).

Reckoning expects to live in either your controller or model layer, and will provide you with a view function that you can pass to your application's view, and can thereafter be displayed using m.render or m.mount. It could act as its own controller, but this is unwise - (how will you interact with a Reckoning instance that way?)

This might sound difficult to wrap your head around, but it gives everyone the most amount of flexibility. The smallest possible mountable calendar might look something like...

// could be condensed to one line but then who could read it? :)
// don't do this in the real world - you'll make me sad.
m.mount(document.body, {
  controller: function () {
    this.rk = new Reckoning({calendar: true});
  },
  view: function (ctrl) {
    return ctrl.rk.view();
  }
});

Generally you'd more likely want to access the calendar or timeline view separately and wrap them in different page components, though...

m.mount(document.body, {
  controller: function () {
    this.rk = new Reckoning({
      calendar: true,
      timeline: true
    });
  },
  view: function (ctrl) {
    var rk = ctrl.rk;
    return m('div', [
      rk.timeline.view(),
      rk.calendar.view()
    ]);
  }
});

Roadmap

More Comprehensive Test Suite
moment.js Integration Example
Adjustable Calendar Weeks
Timeline Mapping/Visuals
Second Sample Theme

@infinitebrahmanuniverse/nolb-reck @everything-registry/sub-chunk-2632

8 years ago

8 years ago

8 years ago

8 years ago