jQuery yacal

Yet Another Calendar plugin for jQuery

View the Project on GitHub eduludi/jquery-yacal

jQuery yacal

Yet Another Calendar plugin for jQuery.

What is yacal?

Yacal is a lightweight (~3.5KB min / ~1.5kb gzip) jQuery calendar plugin, easy to configure and use. It comes with a default template, but you can tune up at your taste, and it also supports some basic internationalization.

The main idea behind yacal is getting a basic calendar DOM structure that you can use as you please. So, do whatever you want with it.

What is not?


Here is a Demo page


yacal only requires jQuery (>= v1.8.x) as dependency. So, just include the script after the jQuery library (unless you are packaging scripts somehow else):

<!-- uncompressed (~7.2kb, for development) --> 
<script src="/path/to/jquery.yacal.js"></script>

<!-- OR compressed (~3.5kb, for production) --> 
<script src="/path/to/jquery.yacal.min.js"></script>

Note: yacal's javascripts and stylesheets are located in project's dist folder


With data-* attributes

<div class="yacal" data-date="2020/10/26" data-near-months="2"></div>

with Javascript

<div id="calendar2000"></div>
    date: '2000/1/1',
    nearMonths: 1,

Default Configurations

options = {
    date: new Date(),    // Sets the date. i.e: '2010/10/10', '2012/06' , default is now
    nearMonths: 0,       // How many months will be displayed to each side. Default is 0
    showWeekdays: true,  // Toggles the week days ('Su','Mo','Tu',etc). Default is true
    minDate: null,       // Sets the minimal date range (inclusive). For markup only. Default is null
    maxDate: null,       // Sets the maximal date range (inclusive). For markup only. Default is null
    //firstDay: 0,       // Sets the first day of the week. Default is 0 (Sunday) (TODO)


CSS Styles

There is a CSS file in the project (dist/jquery.yacal.css) with some basic definitions for yacal's default template.


In yacal is possible to configure the resulting output. The plugin provides access to all the templates used in the rendering. Just keep in mind that every month has this structure:

<!-- pseudo-html -->
            <day /> 
            <day /> 

Default templates:

  tpl: { 
    day: '<a class="day d#weekday##weekend##today##selected##active#" data-time="##time#">#day#</a>',
    weekday: '<i class="weekday wd#weekday#">#weekdayName#</i>',
    week: '<div class="week week#week##weekSelected#" data-time="#weekTime#">|</div>',
    month: '<div class="month #month#"><h4>#monthName# #year#</h4>|</div>',
    nav: '<div class="yclNav">'+
           '<a class="prev"><span>#prev#</span></a>'+
           '<a class="pext"><span>#next#</span></a>'+
    wrap: '<div class="wrap"></div>'
    clearfix: '<div class="clearfix"></div>'

Note A: in nav's template, yclNav, prev and next should stay within the class attributes of both nav links and the yclNav wrapper, as they are required to navigate between months. Is possible to add your own classes, but don't remove these original ones.


    tpl: {
      // adds new classes ('myNav' and 'myNext'), 
      // but keeping the originals (`yclNav`, `prev` and `next`)
      nav: '<div class="yclNav myNav">'+
             '<a class="prev"><strong>#prev#</strong></a>'+ 
             '<a class="next myNext"><strong>#next#</strong></a>'+

Note B: in week's and month's templates, there are pipe characters, |, that are also required. Is there where week's days will be placed.


    tpl: {
      // Don't render weeks
      week: '|',
      // Simplifies the month header
      month: '<div class="month"><h2>#monthName#</h2>|</div>',

Templates Placeholders

The plugin provides several placeholders for each template. These placeholders will return specific information about current element. Except a couple of them, most are not required to be used.

Day's placeholders
Weekday's placeholders
Week's placeholders
Month's placeholders
Nav paceholders



  i18n: {
    weekdays: ['Su','Mo','Tu','We','Th','Fr','Sa'],
    months: ['Jan','Feb','Mar','Apr','May','Jun',
    prev: 'prev', // prev month label
    next: 'next', // next month label


Spanish version

  i18n: {
    weekdays: ['Do','Lu','Ma','Mi','Ju','Vi','Sa'],
    months: ['Ene','Feb','Mar','Abr','May','Jun',

English long months names

  i18n: {
    months: ['January','February','Marz','April','May','June',

Coffeescript compilation

Yacal source is written in Coffeescript and is compiled and minfied using Gulp.

If you want to use this Gulp task to complile and minify the code, you should install the project dependencies using Node's npm:

$ npm install

Once the dependencies are satisfied, you can run the watch task:

$ gulp watch

As you make changes and save the source code, this will watch for those changes and output two files in the dist folder:

ToDos and ideas