Skip to content

WeAreHaus/add2calendar

 
 

Repository files navigation

Add2Calendar

Bower Version Npm Version Release Version Downloads

Allow you to add event to calendar easier

Screenshot 1

Feature

  • Single Event: Google
  • Single Event: iCal
  • Single Event: Outlook
  • Single Event: Outlook Online (disabled since v1.1.0)
  • Single Event: Yahoo!
  • Multi Event: iCal
  • Multi Event: Outlook

Compatible with all browsers:

  • Google Chrome 19+
  • Mozilla Firefox 3.5+
  • Safari 6+
  • Internet Explorer 10+
  • Opera 11.5

Getting Started

Install

1. Install via `npm`
1.1 Install npm
1.2 Install package: `npm install --save add2calendar`

2. Install via `bower`
2.1 Install npm
2.2 Install bower: `npm install -g bower`
2.3 Install package: `bower install --save add2calendar`
Example usage

var singleEventArgs = {
  title       : 'Add2Calendar plugin event',
  start       : 'July 27, 2016 10:30',
  end         : 'July 29, 2016 19:20',
  location    : 'Bangkok, Thailand',
  description : 'Event description'
};
var singleEvent = new Add2Calendar(singleEventArgs);
singleEvent.createWidget('#single-normal');
Parameters

---- Example
title       : 'Add2Calendar plugin event',
start       : 'July 27, 2016 10:30',
end         : 'July 29, 2016 19:20',
location    : 'Bangkok, Thailand',
description : 'Event description.'

---- Default
title       : ''
location    : ''
description : ''

---- Type
title       : <string>
location    : <string>
start       : <string> (date format) (required)
end         : <string> (date format) (required)
description : <string>

Why this plugin

Apologize me, if I miss something

1: Simple

2: Many plugins do not meet my requirements

2.1 [addevent.com](https://www.addevent.com/)
- Not free

2.2 [addtocalendar](http://addtocalendar.com/)
- Google: OK
- iCal: OK
- Outlook: OK
- Outlook Online: not working (tested at 25/07/2016)
- Yahoo!: incorrect end date (tested at 25/07/2016)
- They link to their own service
- They add their own "description" at the bottom of event's description

2.3 [add-to-calendar-buttons](https://github.com/carlsednaoui/add-to-calendar-buttons)
- Google: OK
- iCal: OK
- Outlook: OK
- Outlook Online: don't have
- Yahoo!: incorrect date (tested at 25/07/2016)

2.4 [jquery.addtocalendar](https://github.com/tardate/jquery.addtocalendar)
- Google: OK
- iCal: don't have
- Outlook: don't have
- Outlook Online: incorrect date, event and description not working (tested at 25/07/2016)
- Yahoo!: OK

Important changelog

1.1.0
- Remove `setLang` API (using `setOption` instead)
- Remove outlook-online from the list

1.0.0
- First release

Future Update

  • Update Google format to new format
  • Submit to bower
  • Submit to npm
  • Wordpress plugin
  • start and end parameters can be Date objet
  • Refactor
  • Unit test
  • Create default value of end variable (should be equal start + 1 day)
  • Support ES6 (module export)
  • Complete DocBlockr
  • Support callback function
  • Set language
  • Support download attr
  • Refactor
  • Refactor option parameter
  • Implement tape
  • Separate utilitie function of out main file

Format and others

Helper tool

About

📆 Allow you to add event to calendar easier

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 72.0%
  • HTML 14.7%
  • CSS 13.3%