add-to-calendar-button-mentor

v2.6.17

A convenient JavaScript snippet, which lets you create beautiful buttons, where people can add events to their calendars. For more information about how to use this package see README

Latest version published 7 months ago

License: ELv2

NPM

GitHub

Package Health Score

74 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.6.17	\|	06/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

ELv2

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (36)

GitHub Stars: 1.36K
Forks: 115
Contributors: 20

Direct Usage Popularity

The npm package add-to-calendar-button-mentor receives a total of 36 downloads a week. As such, we scored add-to-calendar-button-mentor popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package add-to-calendar-button-mentor, we found that it has been starred 1,362 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 20
Funding: Yes

With more than 10 contributors for the add-to-calendar-button-mentor repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 1
Open PR: 6
Last Release: 7 months ago
Last Commit: 1 month ago

Further analysis of the maintenance status of add-to-calendar-button-mentor based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that add-to-calendar-button-mentor demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=18.17.0

Age: 7 months
Dependencies: 1 Direct
Versions: 3
Install Size: 4.64 MB
Dist-tags: 1
# of Files: 42
Maintainers: 1
TS Typings: No

add-to-calendar-button-mentor has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Your next Add to Calendar Button

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.

▶️ Demo

See add-to-calendar-button.com for a live demo and playground.

✨ Features

Simple and convenient integration of 1 or many buttons, configurable directly within the HTML code.

Supported Calendars

Google Calendar.
Apple Calendar.
Yahoo Calender.
Microsoft 365, Outlook, and Teams.
Automatically generated iCal/ics files (for all other calendars and cases).

Event Types

Timed and all-day events.
One-time, multi-date, recurring.
Calendar subscription.
Most robust time zone and daylight saving management (via our own TimeZones iCal Library).
Dynamic dates (like "today + 3").

Look

Beautiful and adjustable UI.
Light and dark mode.
Multiple themes.

Accessibility

Optimized and adjustable UX (for desktop and mobile).
Dynamic dropdown positioning.
Taking care of all those edge cases, where some scenarios do not support specific setups (like WebView blocking downloads); utilizing beautiful user guidance workarounds.
Auto-generated Schema.org rich (structured) data for better SEO.
Full support for mouse, touch, or keyboard input (W3C WAI compliant).
Supporting 20+ languages, incl. RTL text for Arabic & Persian; but also custom labels and text blocks (i18n).

And much more

Well documented code, to easily understand the processes and build on top of it.
No external service or backend dependencies.
Fully GDPR, CCPA, and LGPD compliant by design - without the need of signing some data processing agreement.
FREE and easy.

🚀 Go PRO

ics file generation and hosting for better compatibility.
RSVP, incl. automatic updates sent to attendees, GDPR features, and more.
More customization - all no-code.
API, webhooks, and more technical toys.
Share events among all kinds of channels - email, social media, ...

Check the details at add-to-calendar-pro.com!

📦 Installation / Setup

Option 1: simple (CDN)

You can use the jsDelivr CDN and load the respective script directly into your website.

Place the script tag inside the `` section.

Option 2: npm

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.

🎛️ Configuration

A button can be easily created by using the respective custom element.

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".

Structure (PRO)

Minimal structure (no PRO)

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.

A more powerful example (no PRO)

More Examples • Full Configuration Documentation • PRO Version

🤗 Support it!

You like this project? It would be awesome if you would support it, so it lives on!

⭐ Star the repository in order to stay up-to-date and save it for later!
📣 Spread the word! On Twitter/X, Medium, Discord, Facebook, ...
✍️ Leave a review at ProductHunt.
💌 Send us some positive feedback at the discussion board.

⚡ Changelog

Find all changes in the dedicated file at CHANGELOG.md.

🙌 Contributing

Anyone is welcome to contribute, but mind the guidelines:

IMPORTANT NOTE: Run npm install and npm run format to auto-lint!

📃 Copyright and License

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. 😃

💜 Kudos go to

...all amazing contributors:

add-to-calendar-button-mentor dependencies

timezones-ical-library

FAQs

What is add-to-calendar-button-mentor?

A convenient JavaScript snippet, which lets you create beautiful buttons, where people can add events to their calendar... Visit Snyk Advisor to see a full health score report for add-to-calendar-button-mentor, including popularity, security, maintenance & community analysis.

Is add-to-calendar-button-mentor popular?

The npm package add-to-calendar-button-mentor receives a total of 36 weekly downloads. As such, add-to-calendar-button-mentor popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is add-to-calendar-button-mentor well maintained?

We found indications that add-to-calendar-button-mentor maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is add-to-calendar-button-mentor safe to use?

The npm package add-to-calendar-button-mentor was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 06:21 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP