JavaScript library to generate an event link for Google Calendar, Yahoo! Calendar, Microsoft Outlook, etc.
import { google, outlook, yahoo, ics } from "calendar-link"
// Set event as an object
const event = {
title: "My birthday party",
description: "Be there!",
starts: "2019-12-29 18:00:00 +0100",
duration: [3, "hour"]
};
// Then fetch the link
google(event); // https://calendar.google.com/calendar/render...
outook(event); // https://outlook.live.com/owa/...
yahoo(event); // https://calendar.yahoo.com/?v=60&title=...
ics(event); // standard ICS calendar base on https://icalendar.org/| Property | Description | Allowed values |
|---|---|---|
title 👍 |
Event title | String |
start 👍 |
Start time | JS Date / ISO 8601 string / Unix Timestamp |
end 🤙 |
End time | JS Date / ISO 8601 string / Unix Timestamp |
duration 🤙 |
Event duration | Array with value (Number) and unit (String) |
allDay 🤙 |
All day event | Boolean |
description 👌 |
Information about the event | String |
location 👌 |
Event location in words | String |
busy 👌 |
Mark on calendar as busy? | Boolean |
guests 🤞 |
Emails of other guests | Array of emails (String) |
The duration field is ignored if allDay is used.
| Emoji | Meaning |
|---|---|
| 👍 | Required |
| 🤙 | Any one is required |
| 👌 | Supported but not required |
| 🤞 | Not all calendars support |
MIT © Anand Chowdhary
Thanks goes to these wonderful people (emoji key):
 Anand Chowdhary 💻 📖 |
 Harry Lachenmayer 💻 📖 |
 Alexandru-Ionut Imbrea 💻 |
 Kamran Gh 💻 |
 Paul Hebert 🐛 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!