Skip to content

Latest commit

 

History

History
107 lines (77 loc) · 6.87 KB

README.md

File metadata and controls

107 lines (77 loc) · 6.87 KB
Raw

angular-addtocalendar

v1.2.0

An AngularJS directive for adding an event to calendar apps. It supports .ics files for iCalendar and Outlook and also supports Google Calendar, Yahoo! Calendar and Microsoft Calendar.

Enjoy!

Coverage Status Build Status npm version License

dependency Status devDependency Status

Installation

  1. Add source

    bower:

    bower install angular-addtocalendar --save

    npm:

    npm i angular-addtocalendar --save

  2. If you're using webpack, you need to require the module.

    require('angular-addtocalendar');

    with es6:

    import 'angular-addtocalendar';

  3. Inject the dependency jshor.angular-addtocalendar into your app:

    angular
  .module('myApp', [
    'jshor.angular-addtocalendar', 
    'ui.bootstrap',
    ...
  ]);

Demo

For a demo, please click here.

Example

<addtocalendar
    start-date="20150704T190000"
    end-date="20150704T210000"
    title="Fourth of July Fireworks"
    location="Battery Park City, New York, NY"
    class-name="btn btn-sm btn-default dropdown-toggle"
    description="Celebrate the independence of the United States with fireworks in one of the greatest cities in the world."
    btn-text="Add to calendar">
</addtocalendar>

Attributes

Attribute Description Format Example Required
title Name of the event. String Fourth of July Fireworks Yes
description Description of the event. String, defaults to empty Celebrate the independence of the United States with fireworks in one of the greatest cities in the world. No
location Location of the event. Plain text Battery Park City, New York, NY Yes
start-date The timestamp of when the event begins. Date string. Should match format of end-date or format. July 4 2017 7:00 PM UTC+500 Yes
end-date The timestamp of when the event ends. Date string. Should match format of start-date or format. July 4 2017 10:00 PM UTC+500 Yes
format The format that the start-date and end-date are in. May include timezone. mm/dd/yyyy hh:mm:ss Z `MMMM d YYYY h:m A Z No
timezone Any valid momentjs UTC offset Moment America/New_York No
class-name The desired class for the dropdown. See styling. Bootstrap class/plain text. Default btn btn-sm btn-default dropdown-toggle btn btn-sm btn-default dropdown-toggle No
btn-text Text for the button to display Plain text. Default Add to calendar Add to calendar No
uib-dropdown Whether to use ui-bootstrap dropdown null Default Add to calendar null No

Styling

@TODO

Browser Support

All browsers support adding to Yahoo!, Microsoft, and Google calendars. Below is the current support for downloading .ics files for Outlook and iCalendar.

Browser .ics Support
Internet Explorer 9.0+
Edge Yes
Safari 9+
Firefox 20.0+
Opera 15.0+
Chrome 14.0+
Android 4.4+

Bugs

Please report all bugs here.

Changelog

Available here.