google-calendar-url's Introduction

google-calendar-url

Generate shareable URLs for adding Google Calendar events.

Features

Written in TypeScript and includes type definitions.

No dependencies
Works with vanilla JavaScript and TypeScript
Adheres to Semantic Versioning

Installation

yarn add google-calendar-url
# or
npm install google-calendar-url --save

Usage

import { googleCalendarEventUrl } from 'google-calendar-url';

const url = googleCalendarEventUrl({
  start: '20201212T100000Z',
  end: '20201212T110000Z',
  title: 'Event title',
  details: 'Event details',
  location: 'San Francisco',
});

console.log(url);

// https://calendar.google.com/calendar/event?action=TEMPLATE&dates=20201212T100000Z%2F20201212T110000Z&text=Event+title&details=Event+details&location=San+Francisco

Try the URL

API

The googleCalendarEventUrl function takes a single GoogleCalendarEventArgs argument.

interface GoogleCalendarEventArgs {
  /**
   * Start of event, acceptable formats are:
   *
   * 20200316T010000Z - UTC
   *
   * 20200316T010000 - Time local to the user
   *
   * 20200316 - All day event
   */
  start?: string;

  /**
   * End of event, acceptable formats are:
   *
   * 20200316T010000Z - UTC
   *
   * 20200316T010000 - Time local to the user
   *
   * 20200316 - All day event
   */
  end?: string;

  /** Event title */
  title?: string;

  /** Event location */
  location?: string;

  /** Event details */
  details?: string;
}

References

Inofficial spec

Maintainers

@lirbank

google-calendar-url's People

Contributors

Stargazers

Watchers

google-calendar-url's Issues

Do more than string concatenation

Hey,

there is a great opportunity for this module to do a little more than just concatenate the strings together. The "difficult" part about the calendar links is getting the right format for the dates, since Google uses a rather unconventional format.
Without too much work you could enhance the functionality and let users pass real JS date objects for the dates, then format them:

const start = new Date(); // or whatever the user supplies
const formattedStart = start.toISOString().replace(/-/g, '').replace(/:/g, '').replace('.000', '');