https://github.com/valcol/react-hydration-on-demand
Hydrate your React components only when you need to.
https://github.com/valcol/react-hydration-on-demand
code-splitting fid hydration progressive-hydration react render ssr tti
Last synced: 27 days ago
JSON representation
Hydrate your React components only when you need to.
- Host: GitHub
- URL: https://github.com/valcol/react-hydration-on-demand
- Owner: valcol
- License: mit
- Created: 2019-12-29T22:37:15.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-07-22T04:59:19.000Z (7 months ago)
- Last Synced: 2025-10-10T09:38:05.088Z (5 months ago)
- Topics: code-splitting, fid, hydration, progressive-hydration, react, render, ssr, tti
- Language: JavaScript
- Homepage:
- Size: 1.64 MB
- Stars: 197
- Watchers: 4
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
💧
react-hydration-on-demand
Hydrate your React components only when needed.
npm i react-hydration-on-demand
yarn add react-hydration-on-demand
[](https://codesandbox.io/p/sandbox/stoic-sinoussi-64wys6)
Hydrates server-side rendered components only when necessary to offload the main thread, improving TTI, TBT, and FID.
It can be used with code-splitting libraries to load component code at runtime just before the hydration step, reducing the initial payload size of your application.
## How to use
```js
import withHydrationOnDemand from "react-hydration-on-demand";
import Card from "../Card";
//Hydrate when the component enters the viewport
const CardWithHydrationOnDemand = withHydrationOnDemand({ on: ["visible"] })(
Card
);
//Hydrate when the browser's event loop is idle
const CardWithHydrationOnDemand = withHydrationOnDemand({ on: ["idle"] })(Card);
//Hydrate after a delay (by default: 2000ms)
const CardWithHydrationOnDemand = withHydrationOnDemand({ on: ["delay"] })(
Card
);
//Hydrate after a custom delay (3000ms)
const CardWithHydrationOnDemand = withHydrationOnDemand({
on: [["delay", 3000]],
})(Card);
//Hydrate when the user scroll on the document
const CardWithHydrationOnDemand = withHydrationOnDemand({
on: [["scroll", () => document]],
})(Card);
//Hydrate when the when the browser's event loop is idle or when the user scroll, whichever comes first
const CardWithHydrationOnDemand = withHydrationOnDemand({
on: ["idle", "visible"],
})(Card);
//Load an async chunck before hydration
import loadable from "@loadable/component";
const LoadableCard = loadable(() => import("../Card"));
const CardWithHydrationOnDemand = withHydrationOnDemand({
on: [["scroll", () => document]],
onBefore: LoadableCard.load,
})(LoadableCard);
//Never hydrate unless the prop forceHydration is set to true
const CardWithHydrationOnDemand = withHydrationOnDemand()(Card);
//...
export default class App extends React.Component {
render() {
return ;
}
}
```
> ### What if my component is also used client side only ?
>
> If the component isn't rendered server side, it will render directly and behave normally.
## Options
### `on: Array`
An array of events who will trigger the hydration.
Can contains event names directly or as an array of `['event name', options]`.
```js
import withHydrationOnDemand from "react-hydration-on-demand";
import Card from "../Card";
const CardWithHydrationOnDemand = withHydrationOnDemand({
on: ["visible", ["scroll", () => document], ["delay", 5000]],
})(Card);
```
Support [all DOM events](https://developer.mozilla.org/en-US/docs/Web/Events) and more :
| Event name | Options | Description |
| ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| [**all DOM events**](https://developer.mozilla.org/en-US/docs/Web/Events) | `getTarget: Function` who return the event target (default: the wrapped component) |
| **delay** | `delay: Number` in ms (default value: 2000) | Scheduled hydration. |
| **visible** | `getOptions: Function` who return an [intersectionObserver options](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver) object (default: no options) | Requires IntersectionObserver. **Polyfill not included.** If unsupported the component is directy hydrated. |
| **idle** | | Requires requestIdleCallback. **Polyfill not included.** If unsupported the component will be hydrated with a delay of 2000ms. |
### `onBefore: Promise` (optional)
Promise to resolve before hydration.
> Can be usefull if you need to preload chunks before hydration for example.
```js
import withHydrationOnDemand from "react-hydration-on-demand";
import loadable from "@loadable/component";
const LoadableCard = loadable(() => import("../Card"));
const CardWithHydrationOnDemand = withHydrationOnDemand({
on: ["visible"],
onBefore: LoadableCard.load,
})(LoadableCard);
```
### `whenInputPending: Boolean` (optional, default: false)
When set to true use `navigator.scheduling.isInputPending` to check if there is a pending user input on mount. If that's the case, hydration will be delayed using the strategies defined in the `on` option to allow the browser to handle the user input.
If there is no pending input, the component will be hydrated directly to be interactive as fast as possible.
See https://github.com/WICG/is-input-pending for more infos.
### `isInputPendingFallbackValue: Boolean` (optional, default: true)
The default value returned on browsers who don't implements `navigator.scheduling.isInputPending` when `whenInputPending` set to true.
### `disableFallback: Boolean` (optional, default: false)
If set at true the component will not be rendered client side if not rendered server side.
## Props
### `wrapperProps: Object` (optional)
Props that are applied to the div which wraps the provided component.
#### `wrapperProps.as: String | React.ComponentType` (optional, default: 'section')
Specifies the HTML element or React component to use as the wrapper. This allows for semantically correct and accessible markup. For example, use `'div'` for generic containers or `'a'` for links.
```js
import withHydrationOnDemand from "react-hydration-on-demand";
import Card from "../Card";
const CardWithHydrationOnDemand = withHydrationOnDemand({ on: ["delay"] })(Card);
export default class App extends React.Component {
render() {
return (
);
}
}
```
### `forceHydration: Boolean` (optional, default: false)
Force the hydration of the component.
## Playground & Bug Reproduction
You can use the following CodeSandbox to try out the library or reproduce bugs. When creating a new issue, please fork this sandbox and include the link in your bug report to help me understand and fix the problem more efficiently.
[](https://codesandbox.io/p/sandbox/stoic-sinoussi-64wys6)