rkajs

✨ Features

• Lightweight
• You will be able to use the latest React Hooks.
• Not based on React Router, so you can use it wherever you need to cache it.
• You can easily use <KeepAlive> to wrap your components to keep them alive.
• Because it is not controlled by display: none | block, you can use animation.
• Ability to manually control whether your components need to stay active.

📦 Installation

To use rka with your React app:

npm install rkajs
yarn add rkajs
pnpm i rkajs
bun i rkajs

Usage

import { KeepAlive, KeepAliveTransfer } from "rkajs";
import { BrowserRouter, Link, Routes, Route } from "react-router-dom";
import Home from "./pages/Home";
import Form from "./pages/Form";

const AliveHomeView = KeepAliveTransfer(Home, "home");
const AliveFormView = KeepAliveTransfer(Form, "form");

export default function App() {
  return (
    <BrowserRouter>
      <KeepAlive>
        <div>
          <ul>
            <li>
              <Link to={"/"}>Home</Link>
            </li>
            <li>
              <Link to={"/form"}>Form</Link>
            </li>
          </ul>
          <div>
            <Routes>
              <Route path="/" element={<AliveHomeView></AliveHomeView>}></Route>
              <Route
                path="/form"
                element={<AliveFormView></AliveFormView>}
              ></Route>
            </Routes>
          </div>
        </div>
      </KeepAlive>
    </BrowserRouter>
  );
}

💡 Why do you need this component?

If you've used Vue, you know that it has a very good component (keep-alive) that keeps the state of the component to avoid repeated re-rendering.

Sometimes, we want the list page to cache the page state after the list page enters the detail page. When the detail page returns to the list page, the list page is still the same as before the switch.

Oh, this is actually quite difficult to achieve, because the components in React cannot be reused once they are uninstalled. Two solutions are proposed in issue #12039. By using the style switch component display (display: none | block;), this can cause problems, such as when you switch components, you can't use animations; or use data flow management tools like Mobx and Redux, but this is too much trouble.

In the end, I implemented this effect through the React.createPortal API. react-keep-alive has two main components <Provider> and <KeepAlive>. The <Provider> is responsible for saving the component's cache and rendering the cached component outside of the application via the React.createPortal API before processing. The cached components must be placed in <KeepAlive>, and <KeepAlive> will mount the components that are cached outside the application to the location that really needs to be displayed.

🐛 Issues

If you find a bug, please file an issue on our issue tracker on GitHub.

📄 License

rks is available under the MIT License.

Inspired

Inspired by react-keep-alive