Simple and customizable calender components for Vue
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
sandbox
src
.babelrc
.gitignore
LICENSE
README.md
gulpfile.babel.js
package.json
webpack.config.js
yarn.lock

README.md

Days Calendar

Simple and customizable calender for Vue, which only used moment.js and no more other dependencies.

This project still under active development, please feel free to open issues or pull request.

Demo

http://days.sardo.work/

Features

  • Customizable days and weekdays output
  • Customizable style

Installation

npm install days-calendar --save

or

yarn add days-calendar

Usage

Import module from days-calendar, then register it to Vue:

Base

import DaysCalendar from 'days-calendar';

new Vue({
  el: '#your-dom-element',
   components: {
      Calendar: DaysCalendar
   }
})

Custom Modal

By default, Days Calendar will show a modal which contain event content. If you want to custom the template of modal, you can call calendar like this:

   <Calendar>
     <div slot="modal-content">
       <h1>Hello World!</h1>
     </div>
   </Calendar>

If you want to using day object in custom modal, you should pass renderDay function to calendar like this:

<Calendar :renderDay="getDate">
 <div slot="modal-content">
   {{day.content}}
 </div>
</Calendar>
getDate: function(day){
  this.day = day;
  return day;
}

or you will not be allow to access the information of day.

Disable Day

If you don't want user click on some day, you can pass renderDays function to calendar like this:

<Calendar :renderDays="renderDays"></Calendar>
renderDays: function(days){
  return new Promise((resolve, reject) => {
    for(let i = 0; i < days.length; i++){
      const weekday = days[i].date.weekday();
      //If it is Tuesday, disable it
      if(weekday == 2){
        days[i].disabled = true;
      }
    }
     resolve(days);
  });
},

Props

langcode (optional)

A string of language code which used to setting calendar language. Support language:

  1. English - en
  2. Traditional Chinese (Hong Kong) - zh-hk
  3. Traditional Chinese (Taiwan) - zh-tw
  4. Simplified Chinese - zh-cn

Default value is en.

defaultStart (optional)

A string which tell calendar should start on that date. Format is YYYY-MM-DD.

Default value is current date.

Example: 2017-11-03

renderDay (optional)

If you pass this props to Days Calendar, it will pass day object to the function before render the content.

This function should return a day object array.

renderDay(day){
  console.log(day);
  return day;
}

/* Day object:
{ number: (Number of that day), date: (Moment Date Object), class: [] } */

renderDays (optional)

If you pass this props to Days Calendar, it will pass the array of day object to the function before render the content.

This function should return promise which resolve days array or error.

renderDays(year, month, days){
  return new Promise((resolve, reject) => {
     //Do something
     resolve(days);
  });
}

onClick (optional)

If you pass this props to Days Calendar, it will pass the day object to the function before render the content. It will allow you control the behavior after click on any day.

onClick(day){
  console.log('This day is:', day);
}

Contributing

You can clone this repository then start develop at sandbox, or feel free to open issue on github.

Build package:

npm run build

Watch package change and build it:

npm run watch