Rename viewTransitionOpts -> unstable_viewTransitionOpts

remix-run · Oct 11, 2023 · f3db06f · f3db06f
1 parent 54298be
commit f3db06f
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/packages/react-router/lib/components.tsx b/packages/react-router/lib/components.tsx
@@ -167,7 +167,10 @@ export function RouterProvider({
   );
 
   let setState = React.useCallback<RouterSubscriber>(
-    (newState: RouterState, { viewTransitionOpts }) => {
+    (
+      newState: RouterState,
+      { unstable_viewTransitionOpts: viewTransitionOpts }
+    ) => {
       if (
         !viewTransitionOpts ||
         router.window == null ||

diff --git a/packages/router/__tests__/router-test.ts b/packages/router/__tests__/router-test.ts
@@ -17699,7 +17699,7 @@ describe("a router", () => {
           navigation: IDLE_NAVIGATION,
           location: expect.objectContaining({ pathname: "/a" }),
         }),
-        { viewTransitionOpts: undefined }
+        { unstable_viewTransitionOpts: undefined }
       );
 
       // PUSH /a -> /b - w/ transition
@@ -17710,7 +17710,7 @@ describe("a router", () => {
           location: expect.objectContaining({ pathname: "/b" }),
         }),
         {
-          viewTransitionOpts: {
+          unstable_viewTransitionOpts: {
             currentLocation: expect.objectContaining({ pathname: "/a" }),
             nextLocation: expect.objectContaining({ pathname: "/b" }),
           },
@@ -17725,7 +17725,7 @@ describe("a router", () => {
           location: expect.objectContaining({ pathname: "/a" }),
         }),
         {
-          viewTransitionOpts: {
+          unstable_viewTransitionOpts: {
             // Args reversed on POP so same hooks apply
             currentLocation: expect.objectContaining({ pathname: "/a" }),
             nextLocation: expect.objectContaining({ pathname: "/b" }),
@@ -17740,7 +17740,7 @@ describe("a router", () => {
           navigation: IDLE_NAVIGATION,
           location: expect.objectContaining({ pathname: "/" }),
         }),
-        { viewTransitionOpts: undefined }
+        { unstable_viewTransitionOpts: undefined }
       );
 
       unsubscribe();

diff --git a/packages/router/router.ts b/packages/router/router.ts
@@ -408,7 +408,7 @@ export interface RouterSubscriber {
   (
     state: RouterState,
     opts: {
-      viewTransitionOpts?: ViewTransitionOpts;
+      unstable_viewTransitionOpts?: ViewTransitionOpts;
     }
   ): void;
 }
@@ -1015,7 +1015,7 @@ export function createRouter(init: RouterInit): Router {
       ...newState,
     };
     subscribers.forEach((subscriber) =>
-      subscriber(state, { viewTransitionOpts })
+      subscriber(state, { unstable_viewTransitionOpts: viewTransitionOpts })
     );
   }