JavaScript library to generate an event link for Google Calendar, Yahoo! Calendar, Microsoft Outlook, etc.
import calendarLink 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, 'hours']
};
// Then fetch the link
calendarLink.google(event); // https://calendar.google.com/calendar/render...
calendarLink.outook(event); // https://outlook.live.com/owa/...
calendarLink.yahoo(event); // https://calendar.yahoo.com/?v=60&title=...
Property | Description | Allowed values
--- | --- | --- | ---
title
👍 | Event title | String
start
👍 | Start time | JS Date / ISO 8601 / Unix Timestamp
end
🤙 | End time | JS Date / ISO 8601 / Unix Timestamp
duration
🤙 | Event duration | Array with value (Number) and unit (String)
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)
Emoji | Meaning |
---|---|
👍 | Required |
🤙 | Any one is required |
👌 | Supported but not required |
🤞 | Not all calendars support |
MIT © Anand Chowdhary
Generated using TypeDoc