Pass props to parent route element

I have a <Background /> element upstream of the child pages.

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>
const myRouter = createBrowserRouter([
{
path: '/',
element: <ParentLayout />,
children: [
{
path: '/red-page',
element: <RedPage />,
},
{
path: '/green-page',
element: <GreenPage />,
},
],
},
]);
// ParentLayout.tsx
export const ParentLayout = ({ bgColor }) => {
return (
<>
<Background color={bgColor} />
<Outlet />
</>
);
};
</code>
<code> const myRouter = createBrowserRouter([ { path: '/', element: <ParentLayout />, children: [ { path: '/red-page', element: <RedPage />, }, { path: '/green-page', element: <GreenPage />, }, ], }, ]); // ParentLayout.tsx export const ParentLayout = ({ bgColor }) => { return ( <> <Background color={bgColor} /> <Outlet /> </> ); }; </code>

const myRouter = createBrowserRouter([
  {
    path: '/',
    element: <ParentLayout />,
    children: [
      {
        path: '/red-page',
        element: <RedPage />,
      },
      {
        path: '/green-page',
        element: <GreenPage />,
      },
    ],
  },
]);


// ParentLayout.tsx
export const ParentLayout = ({ bgColor }) => {
  return (
    <>
      <Background color={bgColor} />
      <Outlet />
    </>
  );
};

Each child pages should be able to set the background color. What is the best way to achieve that?

(Please keep in mind that it is a toy example, the goal is not really to set the background color, which could be obviously done with a quick DOM/css hack)

Ideal solution

Any child could somehow declare that they need a bgColor="red". React would then proceed to render ParentLayout and the child page.

Issue: Children are rendered after ParentLayout, so it is probably not possible.

Working solution: Using loaders

This works ok, but it has two cons:

  • We are hacking the loader’s primary raison d’être (async data loading).
  • The declaration of background color is taken out of the child component (violates a bit the SoC principle)
Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>
const myRouter = createBrowserRouter([
{
path: '/',
element: <ParentLayout />,
children: [
{
path: '/red-page',
element: <RedPage />,
loader: () => ({ bgColor: 'red' }),
},
{
path: '/green-page',
element: <GreenPage />,
loader: () => ({ bgColor: 'green' }),
},
],
},
]);
// ParentLayout.tsx
export const ParentLayout = () => {
const { bgColor } = useLoadedData()
return (
<>
<Background color={bgColor} />
<Outlet />
</>
);
};
</code>
<code> const myRouter = createBrowserRouter([ { path: '/', element: <ParentLayout />, children: [ { path: '/red-page', element: <RedPage />, loader: () => ({ bgColor: 'red' }), }, { path: '/green-page', element: <GreenPage />, loader: () => ({ bgColor: 'green' }), }, ], }, ]); // ParentLayout.tsx export const ParentLayout = () => { const { bgColor } = useLoadedData() return ( <> <Background color={bgColor} /> <Outlet /> </> ); }; </code>

const myRouter = createBrowserRouter([
  {
    path: '/',
    element: <ParentLayout />,
    children: [
      {
        path: '/red-page',
        element: <RedPage />,
        loader: () => ({ bgColor: 'red' }),
      },
      {
        path: '/green-page',
        element: <GreenPage />,
        loader: () => ({ bgColor: 'green' }),
      },
    ],
  },
]);


// ParentLayout.tsx
export const ParentLayout = () => {
  const { bgColor } = useLoadedData()
  return (
    <>
      <Background color={bgColor} />
      <Outlet />
    </>
  );
};

Working solution: Use useEffect / useLayoutEffect

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>
// ParentLayout.tsx
export const ParentLayout = () => {
const {bgColor} = useSomeStorageOrAContext();
return (
<>
<Background color={bgColor} />
<Outlet />
</>
);
};
// RedPage.tsx
export const RedPage = () => {
const {setBgColor} = useSomeStorageOrAContext();
useLayoutEffect(() => {
setBgColor('red')
}, [])
return (
<div>My Red Page</div>
);
};
</code>
<code> // ParentLayout.tsx export const ParentLayout = () => { const {bgColor} = useSomeStorageOrAContext(); return ( <> <Background color={bgColor} /> <Outlet /> </> ); }; // RedPage.tsx export const RedPage = () => { const {setBgColor} = useSomeStorageOrAContext(); useLayoutEffect(() => { setBgColor('red') }, []) return ( <div>My Red Page</div> ); }; </code>

// ParentLayout.tsx
export const ParentLayout = () => {
  const {bgColor} = useSomeStorageOrAContext();
  return (
    <>
      <Background color={bgColor} />
      <Outlet />
    </>
  );
};

// RedPage.tsx
export const RedPage = () => {
  const {setBgColor} = useSomeStorageOrAContext();
  useLayoutEffect(() => {
    setBgColor('red')
  }, [])
  return (
    <div>My Red Page</div>
  );
};

This approach has the benefit of keeping the route declaration pure, and leaving to the children the choice to modify the background themselves.

Cons:

  • The ParentLayout will be rendered twice. This can possibly be alleviated by using useLayoutEffect to prevent the first unnecessary painting. But it still seems unnecessarily heavy.
  • Such imperative approach is meh. I would love a declarative approach.

Is there a cannonical approach for that?

Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa Dịch vụ tổ chức sự kiện 5 sao Thông tin về chúng tôi Dịch vụ sinh nhật bé trai Dịch vụ sinh nhật bé gái Sự kiện trọn gói Các tiết mục giải trí Dịch vụ bổ trợ Tiệc cưới sang trọng Dịch vụ khai trương Tư vấn tổ chức sự kiện Hình ảnh sự kiện Cập nhật tin tức Liên hệ ngay Thuê chú hề chuyên nghiệp Tiệc tất niên cho công ty Trang trí tiệc cuối năm Tiệc tất niên độc đáo Sinh nhật bé Hải Đăng Sinh nhật đáng yêu bé Khánh Vân Sinh nhật sang trọng Bích Ngân Tiệc sinh nhật bé Thanh Trang Dịch vụ ông già Noel Xiếc thú vui nhộn Biểu diễn xiếc quay đĩa Dịch vụ tổ chức tiệc uy tín Khám phá dịch vụ của chúng tôi Tiệc sinh nhật cho bé trai Trang trí tiệc cho bé gái Gói sự kiện chuyên nghiệp Chương trình giải trí hấp dẫn Dịch vụ hỗ trợ sự kiện Trang trí tiệc cưới đẹp Khởi đầu thành công với khai trương Chuyên gia tư vấn sự kiện Xem ảnh các sự kiện đẹp Tin mới về sự kiện Kết nối với đội ngũ chuyên gia Chú hề vui nhộn cho tiệc sinh nhật Ý tưởng tiệc cuối năm Tất niên độc đáo Trang trí tiệc hiện đại Tổ chức sinh nhật cho Hải Đăng Sinh nhật độc quyền Khánh Vân Phong cách tiệc Bích Ngân Trang trí tiệc bé Thanh Trang Thuê dịch vụ ông già Noel chuyên nghiệp Xem xiếc khỉ đặc sắc Xiếc quay đĩa thú vị
Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa
Thiết kế website Thiết kế website Thiết kế website Cách kháng tài khoản quảng cáo Mua bán Fanpage Facebook Dịch vụ SEO Tổ chức sinh nhật