Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sethmcleod/eventfeed.js
:date: Google Calender Event Feed
https://github.com/sethmcleod/eventfeed.js
Last synced: 3 days ago
JSON representation
:date: Google Calender Event Feed
- Host: GitHub
- URL: https://github.com/sethmcleod/eventfeed.js
- Owner: sethmcleod
- License: mit
- Created: 2015-09-05T23:56:55.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-10-17T21:58:26.000Z (over 9 years ago)
- Last Synced: 2024-12-31T09:36:17.406Z (24 days ago)
- Language: JavaScript
- Homepage: https://sethmcleod.github.io/eventfeed.js/
- Size: 262 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Google Calendar Event Feed
 [](https://travis-ci.org/sethmcleod/eventfeed.js)
Eventfeed.js is a simple plugin for displaying a feed of upcoming events using [Google Calendar API v3](https://developers.google.com/google-apps/calendar/v3/reference/events/list). No jQuery required, it's just plain javascript.
## Installation
Installation is easy: Just download the script from the __dist__ folder and include it in your HTML:
```html
```
## Basic Usage
To use, just declare a variable and assign to that a new instance of Eventfeed. When you're ready to initiate the feed, call the `run()` function on your variable.
```html
var feed = new Eventfeed({
calendarId: '[email protected]'
});
feed.run();
```
Eventfeed will by default look for a `
` and fill it with the events.
```html
{{month}}
{{day}}
{{title}}
{{description}}
{{location}}
From: {{start}}
To: {{end}}
```
## Requirements
The only thing you'll need is a __calendar id__ for the public calendar. This is usually the email address used to create the calendar.
## Standard Options
- `calendarId` (string) - The email address linked to a public calendar. __Required__.
- `target` (string) - The ID of a DOM element you want to add events to.
- `links` (boolean) - Whether or not to link the event elements to their URLs. Default is `true`.
- `abbreviate` (boolean) - Whether or not to abbreviate the names of months. Default is `false`.
- `maxResults` (number) - Maximum number of events returned. Default is `250`.
- `orderBy` (string) - The order of the events returned. Available options are:
- `none` (default) - As they come from Instagram.
- `startTime` - Order by the start date/time (ascending). This is only available when the singleEvents option is `true`.
- `updated` - Order by last modification time (ascending).
- `pastEvents` (boolean) - Whether to include past events. Default is `false`.
- `showDeleted` (boolean) - Whether to include deleted events (with a status of "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both `false`. If showDeleted and singleEvents are both `true`, only single instances of deleted events (but not the underlying recurring events) are returned. Default is `false`.
- `singleEvents` (boolean) - Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Default is `false`.
## Advanced Options
- `before` (function) - A callback function called before fetching events from Google.
- `after` (function) - A callback function called when events have been added to the page.
- `success` (function) - A callback function called when Google returns valid data. (argument -> json object)
- `error` (function) - A callback function called when there is an error fetching events. (argument -> string message)
- `mock` (boolean) - Query the events without inserting into the DOM. Use with the success() callback. Default is `false`.
## FAQ
#### "Why am I getting a JSON error?"
First make sure the calendar linked to your id is public, and the *hide details* option is not checked (this limits JSON data returned).
__Currently only `@gmail.com` addresses are supported.__ Using an account from a different domain, one that is connected through Google Apps, will omit event details and the returned JSON data will be differently formatted.
## To Do List
- Add default styling.
- Test browser compatibility.
- Build test suit using [Mocha](http://mochajs.org/) and [Chai](http://chaijs.com/).
- Add a `template` option for customizing HTML output.
## Change Log
__1.0.0__
- Initial release