add-to-calendar-button-react - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0

dist/AddToCalendarButton.d.ts

 /// <reference types="react" />
+import 'add-to-calendar-button';
 type AddToCalendarButtonProps = {
     proKey?: string;
     name?: string;
-    dates?: object;
+    dates?: object | string;
     description?: string;
@@ -14,9 +15,9 @@ startDate?: string;
     status?: string;
-    sequence?: number;
+    sequence?: number | string;
     uid?: string;
     organizer?: string;
     icsFile?: string;
-    images?: string[];
+    images?: string[] | string;
     recurrence?: string;
-    recurrence_interval?: number;
+    recurrence_interval?: number | string;
     recurrence_until?: string;
@@ -32,4 +33,4 @@ recurrence_count?: string;
     identifier?: string;
-    subscribe?: string;
-    options?: string[];
+    subscribe?: boolean | string;
+    options?: string[] | string;
     iCalFileName?: string;
@@ -39,21 +40,25 @@ listStyle?: string;
     trigger?: string;
-    icons?: string;
-    textLabels?: string;
-    buttonsList?: string;
-    background?: string;
-    checkmark?: string;
-    branding?: string;
+    hideIconButton?: boolean | string;
+    hideIconList?: boolean | string;
+    hideIconModal?: boolean | string;
+    hideTextLabelButton?: boolean | string;
+    hideTextLabelList?: boolean | string;
+    hideBackground?: boolean | string;
+    hideCheckmark?: boolean | string;
+    hideBranding?: boolean | string;
     size?: string;
     label?: string;
-    ty?: object;
-    rsvp?: object;
     inlineRsvp?: string;
-    customLabels?: object;
+    customLabels?: object | string;
     customCss?: string;
     lightMode?: string;
     language?: string;
-    richData?: string;
-    bypassWebViewCheck?: string;
+    hideRichData?: boolean | string;
+    ty?: object | string;
+    rsvp?: object | string;
+    bypassWebViewCheck?: boolean | string;
+    debug?: boolean | string;
+    blockInteraction?: boolean | string;
 };
 declare const AddToCalendarButton: (props: AddToCalendarButtonProps) => JSX.Element;
 export default AddToCalendarButton;

package.json

 {
   "name": "add-to-calendar-button-react",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "engines": {
@@ -64,27 +64,26 @@ "node": ">=16.18.1",
     "test": "vitest",
+    "test:coverage": "vitest --coverage",
     "preview": "vite preview"
   },
-  "dependencies": {
-    "add-to-calendar-button": "^1.18.8"
-  },
   "devDependencies": {
     "@testing-library/react": "^13.4.0",
-    "@types/jest": "^29.2.3",
-    "@types/react": "^18.0.24",
-    "@types/react-dom": "^18.0.8",
-    "@typescript-eslint/eslint-plugin": "^5.45.0",
-    "@typescript-eslint/parser": "^5.45.0",
-    "@vitejs/plugin-react": "^2.2.0",
-    "eslint": "^8.28.0",
-    "eslint-config-prettier": "^8.5.0",
+    "@types/jest": "^29.2.6",
+    "@types/react": "^18.0.27",
+    "@types/react-dom": "^18.0.10",
+    "@typescript-eslint/eslint-plugin": "^5.48.2",
+    "@typescript-eslint/parser": "^5.48.2",
+    "@vitejs/plugin-react": "^3.0.1",
+    "@vitest/coverage-c8": "^0.27.3",
+    "eslint": "^8.32.0",
+    "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-commonjs": "^1.0.2",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-security": "^1.5.0",
-    "jsdom": "^20.0.3",
-    "prettier": "^2.8.0",
+    "eslint-plugin-security": "^1.6.0",
+    "jsdom": "^21.1.0",
+    "prettier": "^2.8.3",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "typescript": "^4.6.4",
-    "vite": "^3.2.3",
-    "vitest": "^0.25.3"
+    "typescript": "^4.9.4",
+    "vite": "^4.0.4",
+    "vitest": "^0.27.3"
   },
@@ -94,3 +93,6 @@ "peerDependencies": {
     "react-dom": ">=18.0.0"
+  },
+  "dependencies": {
+    "add-to-calendar-button": "^2.0.0"
   }
 }

README.md

 ![Add to Calendar Button React Wrapper](https://github.com/add2cal/add-to-calendar-button-react/blob/main/assets/readme-header.png?raw=true)
 
-![Version](https://img.shields.io/npm/v/add-to-calendar-button-react?style=for-the-badge)
-![Parent Script Version](https://img.shields.io/badge/Parent%20Script%20Version-v1.18.8-blue?style=for-the-badge)
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/add-to-calendar-button-react?style=for-the-badge)
+![Version](https://img.shields.io/npm/v/add-to-calendar-button-react?style=for-the-badge&label=Version)
+[![Parent Script Version](https://img.shields.io/badge/Parent%20Script%20Version-v2.0.0-blue?style=for-the-badge)](https://github.com/add2cal/add-to-calendar-button)
+[![npm bundle size](https://img.shields.io/bundlephobia/minzip/add-to-calendar-button-react?style=for-the-badge)](https://www.npmjs.com/package/add-to-calendar-button-react)
 [![npm Installations](https://img.shields.io/npm/dt/add-to-calendar-button-react?label=npm%20Installations&style=for-the-badge)](https://www.npmjs.com/package/add-to-calendar-button-react)
@@ -56,3 +56,3 @@
 - Timed and all-day events.
-- One-time, multi-date, recurring, or fluid.
+- One-time, multi-date, recurring.
 - Calendar Subscription.
@@ -124,5 +124,8 @@ - Most robust time zone and daylight saving management (via our own [TimeZones iCal Library](https://github.com/add2cal/timezones-ical-library)).
 
-Find all information about the available parameters and how to configure specific features at the [github.com/add2cal/add-to-calendar-button/blob/main/DOCS.md](https://github.com/add2cal/add-to-calendar-button/blob/main/DOCS.md).
-**Mind that different to the main package, with the React wrapper, you can (and need to) actually declare arrays (like with the options prop) as arrays and objects (like with multi-date setups) as objects!**
+Find all information about the available props and how to configure specific features on the demo page at [add-to-calendar-button.com/en/configuration](https://add-to-calendar-button.com/en/configuration).
 
+Mind the difference to the web component! At this wrapper, you would use the `<AddToCalendarButton>` component instead of the `<add-to-calendar-button>` custom element.
+
+**Also mind that, different to the main package, with the React wrapper, you can actually declare arrays (like with the options prop) as arrays and objects (like with multi-date setups) as objects!**
+
 <br />
@@ -136,7 +139,8 @@
 
+- v2.0 : supporting latest major version of the parent script
 - v1.0 : initial release
 
-(Only referring to this wrapper repository and without any patches!)
+(Only referring to this wrapper repository and not including any patches!)
 
-Find all changes regarding the parent package at [github.com/add2cal/add-to-calendar-button/blob/main/CHANGELOG.md](https://github.com/add2cal/add-to-calendar-button/blob/main/CHANGELOG.md).
+Find all changes regarding the parent package at its [CHANGELOG.md](https://github.com/add2cal/add-to-calendar-button/blob/main/CHANGELOG.md).
 
@@ -143,0 +147,0 @@ <br />

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

561627

increased by60.95%

Lines of code

3836

increased by28.51%

Number of lines in readme file

187

increased by2.19%

Worsened metrics

Dev dependency count

20

increased by5.26%

Number of package files

10

decreased by-16.67%

Dependency changes

• + Addedadd-to-calendar-button@2.8.1(transitive)

• - Removedadd-to-calendar-button@1.18.8(transitive)

• Updatedadd-to-calendar-button@^2.0.0