import React, { useState, useEffect, useRef } from 'react'; import { useOutlet, useLocation } from 'react-router-dom'; import ActivityComponent from './Activity.js'; // @ts-ignore const Activity = React.unstable_Activity || ActivityComponent; interface ActivityItem { outlet: React.ReactElement | null; key: string; pathname: string; } interface OutletProps { // The limitation number of outlets to keep alive. limit?: number; // When paths is configured, only the specified paths will be kept alive. paths?: string[]; } const OUTLET_LIMIT = 5; export default function KeepAliveOutlet(props: OutletProps) { if (!Activity) { throw new Error('`` now requires react experimental version. Please install it first.'); } const [outlets, setOutlets] = useState([]); const location = useLocation(); const outlet = useOutlet(); const outletLimit = props.limit || OUTLET_LIMIT; const keepAlivePaths = props.paths; // Save the first outlet for SSR hydration. const outletRef = useRef({ key: location.key, pathname: location.pathname, outlet, }); useEffect(() => { // If outlets is empty, save the first outlet for SSR hydration, // and should not call setOutlets to avoid re-render. if (outlets.length !== 0 || outletRef.current?.pathname !== location.pathname) { let currentOutlets = outletRef.current ? [outletRef.current] : outlets; // Check current path if exsist before filter, to avoid infinite setOutlets loop. const result = currentOutlets.some(o => o.pathname === location.pathname); if (keepAlivePaths && keepAlivePaths.length > 0) { currentOutlets = currentOutlets.filter(o => keepAlivePaths.includes(o.pathname)); } if (!result) { setOutlets([ ...currentOutlets, { key: location.key, pathname: location.pathname, outlet, }, ].slice(-outletLimit)); outletRef.current = null; } } }, [location.pathname, location.key, outlet, outlets, outletLimit, keepAlivePaths]); // Render initail outlet for SSR hydration. const renderOutlets = outlets.length === 0 ? [outletRef.current] : outlets; return ( <> { renderOutlets.map((o) => { return ( {o.outlet} ); }) } ); }