Route Transition Flickering in React Router Framework v7 (Private Routing)

[ProfessorMR]

Select Topic Area

Bug

Body

I'm currently developing a project utilizing React Router v7 framework where I need to implement protected routes. While I've successfully implemented the protection mechanism, I'm encountering an issue where the protected page's layout briefly flashes before the redirect occurs. I want to prevent this behavior by ensuring the redirect happens before any page rendering takes place. Below are my route.jsx and protected.jsx implementations:

import { useEffect } from "react";
import { Outlet, useNavigate } from "react-router";
import { useDispatch } from "react-redux";
import { getTokenFromCookie } from "./tokenServices";
import { setOpenAuthModal } from "../redux/slices/authSlice";

const ProtectedRoute = () => {
const dispatch = useDispatch();
const navigate = useNavigate();

const token = getTokenFromCookie();

useEffect(() => {
if (!token) {
dispatch(setOpenAuthModal());
navigate("/");
}
}, [token, dispatch, navigate]);

return token ? : null;
};

export default ProtectedRoute;

import { index, layout, prefix, route } from "@react-router/dev/routes";

export default [
layout("./layouts/AppLayout.jsx", [
index("routes/home/route.jsx"),
route("/support", "routes/support/route.jsx"),
route("/rooms/:villaId", "routes/room/route.jsx"),
route("/archive/:cityName", "routes/archive-city/route.jsx"),

layout("./services/auth/ProtectedRoute.jsx", [
  route("/profile", "routes/profile/dashboard/route.jsx"),
  route("/wallet", "routes/wallet/route.jsx"),
  route("/invite-friends", "routes/invite-friends/route.jsx"),
  route("/trips", "routes/trips/route.jsx"),
  ...prefix("/comments", [
    index("routes/comments/route.jsx"),
    route("/register/:vilaId", "routes/profile/registerComment/route.jsx"),
  ]),

  ...prefix("/host", [
    route("/profile", "routes/host/dashboard/route.jsx"),
    ...prefix("/comments", [
      index("routes/host/comments/route.jsx"),
      route(
        "/:commentId",
        "routes/host/comments/residenceHostComments/route.jsx",
      ),
    ]),
    route("/list-of-resisdence", "routes/host/listOfResisdence/route.jsx"),
    route("/statistics", "routes/host/statistics/route.jsx"),

    // layout("./services/auth/ProtectedReservationHost.jsx", [
    layout("./layouts/hostRegistration/HostRegistrationLayout.jsx", [
      ...prefix("/residence-registration", [
        route(
          "/specifications",
          "routes/host/residence-registration/specifications/create/route.jsx",
        ),
        route(
          "edit/specifications/:registrationId",
          "routes/host/residence-registration/specifications/edit/route.jsx",
        ),
        route(
          "edit/rooms/:registrationId",
          "routes/host/residence-registration/rooms/route.jsx",
        ),
        route(
          "edit/images/:registrationId",
          "routes/host/residence-registration/images/route.jsx",
        ),
        route(
          "edit/facilities/:registrationId",
          "routes/host/residence-registration/facilities/route.jsx",
        ),
        route(
          "edit/neighborhood/:registrationId",
          "routes/host/residence-registration/neighborhood/route.jsx",
        ),
        route(
          "edit/rules/:registrationId",
          "routes/host/residence-registration/rules/route.jsx",
        ),
        route(
          "edit/prices/:registrationId",
          "routes/host/residence-registration/prices/route.jsx",
        ),
        route(
          "edit/documents/:registrationId",
          "routes/host/residence-registration/documents/route.jsx",
        ),
      ]),
    ]),
    // ]),
  ]),

  layout("routes/reservation/route.jsx", [
    route(
      "reservation/checkout/:reserveId",
      "routes/reservation/check/route.jsx",
    ),
    route(
      "reservation/payment/:reserveId",
      "routes/reservation/payment/route.jsx",
    ),
    route(
      "reservation/delivery/:reserveId",
      "routes/reservation/delivery/route.jsx",
    ),
  ]),
]),

]),
// layout("./services/auth/ProtectedRoute.jsx", [
// route("/invoice/reserve/:reserveId", "routes/invoice-reserve/route.jsx"), // ✅ Invoice route here
// ]),
];

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐

[Om-singh-ui]

The flicker happens because you’re redirecting inside useEffect, which runs after the first render. So the protected layout renders briefly before navigation.

Instead of using useEffect + navigate, return a immediately:

`import { Outlet, Navigate } from "react-router";

const ProtectedRoute = () => {
const token = getTokenFromCookie();

if (!token) {
return ;
}

return ;
};`

This prevents the protected layout from rendering at all and removes the flicker.