GithubHelp home page GithubHelp logo

pin-on-calendar's Introduction

GitHub package.json version GitHub Workflow Status Coverage Status GitHub issues npm

pin-on-calendar

Event link generator for all major calendar clients.

Usage:

import { addToCalendar, getClientLink, downloadIcsFile, getIcsData } from "pin-on-calendar";

const event1 = { 
   title: "Hair cut",
   startDate: "2022-11-26T19:02:45.747Z"  
}

const event2 = { 
    title: "College reunion",
    startDate: "2022-12-26T19:02:45.747Z"
}

addToCalendar("google", event); // redirects to google calendar with event data
getClientLink("outlook", event); // https://outlook.live.com/calendar/0/deeplink/compose?path=%2Fcalendar%2Faction%2Fcompose&rru=addevent...

downloadIcsFile([event1, event2], "appointments"); // downloads an appointments.ics file
getIcsData([event1, event2]) // gives an ics file data

API

Table of Contents

addToCalendar

Redirects to the specified calendar client.

Parameters

downloadIcsFile

Downloads the ICS file.

Parameters

getClientLink

Generates the proper link for the provided client.


N.B. For an ics client, this function will produce a Data URL.

Parameters

getIcsData

Generates the ICS file data.

Parameters

Event

Calendar event data

title

Name of the event.

Type: string

startDate

The starting date for the event.

Type: string

endDate

The closing date for the event.

Type: string

description

Description of the event.

Type: string

allDay

Tells whether the event is all day.

Type: boolean

location

Location of the event.

Type: string

rRule

Recurrence rules for the event.

Type: string

organizer

The organizer of the event.

Type: Organizer

busy

Tells whether the event is available.

Type: boolean

guests

Invited guests' emails.

Type: Array<string>

url

A more dynamic rendition of the event information.

Type: string

Organizer

An event organizer

name

The name of the organizer.

Type: string

email

The email of the organizer.

Type: string

Client

Client type

Type: ("google" | "outlook" | "office365" | "yahoo" | "ics")

pin-on-calendar's People

Contributors

dullkingsman avatar github-actions[bot] avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.