fix updated spec params and add a comment for new useNavigate prop

gadget-inc · Oct 27, 2023 · e7e8468 · e7e8468
1 parent 3e75421
commit e7e8468
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 7 deletions.
diff --git a/packages/react/package.json b/packages/react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@gadgetinc/react",
-  "version": "0.14.13",
+  "version": "0.14.14",
   "files": [
     "README.md",
     "dist/**/*"

diff --git a/packages/react/spec/auth/useAuth.spec.ts b/packages/react/spec/auth/useAuth.spec.ts
@@ -73,9 +73,11 @@ describe("useAuth", () => {
   test("returns the correct auth config when signed out", () => {
     const { result, rerender } = renderHook(() => useAuth(), {
       wrapper: MockClientWrapper(fullAuthApi, undefined, {
-        signInPath: "/foo-sign-in",
-        signOutActionApiIdentifier: "newSignOut",
-        redirectOnSuccessfulSignInPath: "/bar-signed-in",
+        auth: {
+          signInPath: "/foo-sign-in",
+          signOutActionApiIdentifier: "newSignOut",
+          redirectOnSuccessfulSignInPath: "/bar-signed-in",
+        },
       }),
     });
 
@@ -93,9 +95,11 @@ describe("useAuth", () => {
   test("returns the correct auth config when signed in", () => {
     const { result, rerender } = renderHook(() => useAuth(), {
       wrapper: MockClientWrapper(fullAuthApi, undefined, {
-        signInPath: "/foo-sign-in",
-        signOutActionApiIdentifier: "newSignOut",
-        redirectOnSuccessfulSignInPath: "/bar-signed-in",
+        auth: {
+          signInPath: "/foo-sign-in",
+          signOutActionApiIdentifier: "newSignOut",
+          redirectOnSuccessfulSignInPath: "/bar-signed-in",
+        },
       }),
     });
 

diff --git a/packages/react/src/GadgetProvider.tsx b/packages/react/src/GadgetProvider.tsx
@@ -36,6 +36,7 @@ export const GadgetConfigurationContext = React.createContext<GadgetConfiguratio
 
 interface BaseProviderProps {
   children: ReactNode;
+  /** By default components/hooks will use `window.location` load new URLs. If you have your own routing provider, the `navigate` prop can be used to push new routes.  */
   navigate?: (path: string) => void;
 }