add-to-calendar-button
Advanced tools
A convenient JavaScript snippet, which lets you create beautiful buttons, where people can add events to their calendars.
The convenient JavaScript Web Component, which lets you reliably create beautiful buttons, where people can add events to their calendars.
For everybody, who wants to include a button at their website or app, which enables users to easily add a specific event to their calendars. It's main goal is to keep this process as easy as possible at maximum compatibility. Simply define your button configuration and everything else is automatically generated by the script. Supporting calendars at Apple, Google, Microsoft (365, Outlook, Teams), Yahoo, and generic iCal.
The script, since it is a web component, integrates easily with any usual HTML webpage (VanillaJS way) as well as popular JavaScript frameworks and libraries like Angular, React, Vue, Svelte, and more.
Works with all modern browsers (Chrome, Edge, Firefox, Safari) on Windows, Mac, Android, and iOS as well as rather restricted webview environments like the Instagram in-app browser.
See add-to-calendar-button.com for a live demo and playground.
Simple and convenient integration of 1 or many buttons, configurable directly within the HTML code.
Check the details at add-to-calendar-pro.com!
You can use the jsDelivr CDN and load the respective script directly into your website.
Place the script tag inside the <head> section.
<script src="https://cdn.jsdelivr.net/npm/add-to-calendar-button@2" async defer></script>
Install the package using the following npm command:
npm install add-to-calendar-button
Import the module into your project/component
import 'add-to-calendar-button';
Based on your framework/library, you might need to make minor adjustments to the respective config.
Find detailed installation guides for the most common ones, like React, Angular, Vue, Svelte, or Astro at add-to-calendar-button.com/#installation.
A button can be easily created by using the respective custom element.
<add-to-calendar-button></add-to-calendar-button>
You can then configure the button by simply adding the options as attributes to it. Boolean values (true/false) can be set as optionName="true" or simply by adding optionName to the tag. Not setting it at all would be automatically translate to "false".
Mind that for auto-generating rich snippets, a location would be mandatory as well.
Calendar type options and time zone information are not required, but recommended.
<add-to-calendar-button
name="Add the title of your event"
startDate="2022-02-21"
options="['Google']"
timeZone="America/Los_Angeles"
>
</add-to-calendar-button>
<add-to-calendar-button
name="Add the title of your event"
description="A nice description does not hurt"
startDate="2022-02-21"
endDate="2022-03-24"
startTime="10:13"
endTime="17:57"
location="Somewhere over the rainbow"
options="['Apple','Google','iCal','Microsoft365','Outlook.com','Yahoo']"
timeZone="Europe/Berlin"
trigger="click"
inline
listStyle="modal"
iCalFileName="Reminder-Event"
>
</add-to-calendar-button>
More Examples • Full Configuration Documentation • PRO Version
You like this project? It would be awesome if you would support it, so it lives on!
Find all changes in the dedicated file at CHANGELOG.md.
Anyone is welcome to contribute, but mind the guidelines:
IMPORTANT NOTE: Run npm install and npm run format to auto-lint!
Copyright (c) Jens Kuerschner.
Licensed under Elastic License 2.0 (ELv2).
About open-source: We consider ourselves open-source. However, we are also aware of the controversy coming with licenses like the one selected. Therefore, and contrary to many other companies and products, we no longer use the term in any marketing statements unless it is about other pieces which really are under an official OSI license.
Speaking about the license: We love it, because it is so simple. Have a look! You are basically free to do anything unless you are not offering the tool itself as a product or service; or want to remove copyright and license stuff. In doubt, simply ask and we find a way. :)
...all amazing contributors:
FAQs
A convenient JavaScript snippet, which lets you create beautiful buttons, where people can add events to their calendars.
The npm package add-to-calendar-button receives a total of 24,162 weekly downloads. As such, add-to-calendar-button popularity was classified as popular.
We found that add-to-calendar-button demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.
