React: 🐛 Fix init to be optional (#2828)

shipshapecode · May 24, 2024 · 488c18a · 488c18a
1 parent 6c5e3a2
commit 488c18a
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/packages/react/README.md b/packages/react/README.md
@@ -11,7 +11,7 @@ that can be passed into props for dynamic interactivity.
 Use this simple NPM command or whatever package manager is your favorite.
 
 ```bash
-npm install --save @shepherdpro/react
+npm install --save react-shepherd
 ```
 
 ## Usage
@@ -33,8 +33,8 @@ const tourOptions = {
 };
 
 function Button() {
-  const shepherd = useShepherd(ShepherdTourContext);
-  const tour = shepherd.Tour({
+  const Shepherd = useShepherd();
+  const tour = new Shepherd.Tour({
     ...tourOptions,
     steps: newSteps
   });

diff --git a/packages/react/src/index.tsx b/packages/react/src/index.tsx
@@ -4,7 +4,7 @@ import Shepherd from 'shepherd.js';
 import type ShepherdPro from 'shepherd.js';
 
 interface ShepherdProviderProps {
-  apiKey: string;
+  apiKey?: string;
   apiPath?: string;
   properties?: Record<string, unknown>;
   children?: ReactNode;
@@ -39,7 +39,7 @@ export const ShepherdJourneyProvider: FC<ShepherdProviderProps> = ({
   children
 }: ShepherdProviderProps) => {
   if (typeof window !== 'undefined') {
-    Shepherd.init(apiKey, apiPath, properties);
+    if (apiKey) Shepherd.init(apiKey, apiPath, properties);
   }
 
   return (