Skip to content

πŸ“… Calendar link generator for popular services

License

Notifications You must be signed in to change notification settings

lachenmayer/calendar-link

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

92 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Calendar Link

Travis Coverage Status GitHub Vulnerabilities NPM type definitions NPM

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

NPM

Usage

import { google, outlook, yahoo } 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=...

Options

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.

Support key

Emoji Meaning
πŸ‘ Required
πŸ€™ Any one is required
πŸ‘Œ Supported but not required
🀞 Not all calendars support

License

MIT Β© Anand Chowdhary

About

πŸ“… Calendar link generator for popular services

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 100.0%