2.6.2 • Published 2 years ago

@philippdormann/calendar-link v2.6.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

📅 Calendar Link

Usage

// Usage with TypeScript or ES6
import { google, outlook, office365, yahoo, ics } from "@philippdormann/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

PropertyDescriptionAllowed values
title (required)Event titleString
start (required)Start timeJS Date / ISO 8601 string / Unix Timestamp
endEnd timeJS Date / ISO 8601 string / Unix Timestamp
durationEvent durationArray with value (Number) and unit (String)
allDayAll day eventBoolean
rRuleRecurring eventiCal recurrence rule string NOTE: Only supported by google and ics
descriptionInformation about the eventString
locationEvent location in wordsString
busyMark on calendar as busy?Boolean
guestsEmails of other guestsArray of emails (String)
urlCalendar document URLString

Notes

  • Any one of the fields end, duration, or allDay is required.
  • The allowed units in duration are listed here: https://day.js.org/docs/en/durations/creating#list-of-all-available-units.
  • 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.
  • If you don't pass the start and end time in UTC, Google will convert it to UTC but Outlook won't, so it's a good idea to use UTC when passing dates and times
2.6.2

2 years ago

2.6.1

2 years ago

2.6.0

2 years ago

2.5.2

2 years ago

2.5.1

2 years ago

2.5.0

2 years ago