README.md

📅 Calendar Link

	Status
Build
Health
PRs
Community

JavaScript library to generate an event link for Google Calendar, Yahoo! Calendar, Microsoft Outlook, etc.

Usage

// Usage with Node.js
const { google, outlook, office365, yahoo, ics } = require("calendar-link");

// Usage with TypeScript or ES6
import { google, outlook, office365, yahoo, ics } from "calendar-link";

// Set event as an object
const event = {
  title: "My birthday party",
  description: "Be there!",
  start: "2019-12-29 18:00:00 +0100",
  duration: [3, "hour"],
};

// Then fetch the link
google(event); // https://calendar.google.com/calendar/render...
outlook(event); // https://outlook.live.com/owa/...
office365(event); // https://outlook.office.com/owa/...
yahoo(event); // https://calendar.yahoo.com/?v=60&title=...
ics(event); // standard ICS file based on https://icalendar.org

Options

Property	Description	Allowed values
title (required)	Event title	String
start (required)	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)
url	Calendar document URL	String

Any one of the fields end, duration, or allDay is required.

The url field defaults to document.URL if a global document object exists. For server-side rendering, you should supply the url manually.

Not all calendars support the guests and url fields.

License

MIT © Anand Chowdhary

Contributors

Thanks goes to these wonderful people (emoji key):

Anand Chowdhary 💻 📖	Harry Lachenmayer 💻 📖	Alexandru-Ionut Imbrea 💻	Kamran Gh 💻	Paul Hebert 🐛 💻	Osman Mazinov 📖	Bob Ippolito 💻 📖
René Hellenes 💻	Andrei Fidelman 💻

This project follows the all-contributors specification. Contributions of any kind welcome!