Security News
Research
Data Theft Repackaged: A Case Study in Malicious Wrapper Packages on npm
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
react-hydration-on-demand
Advanced tools
npm i react-hydration-on-demand
yarn add react-hydration-on-demand
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.
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 <CardWithHydrationOnDemand title="my card" />;
}
}
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.
on: Array
An array of events who will trigger the hydration.
Can contains event names directly or as an array of ['event name', options]
.
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 and more :
Event name | Options | Description |
---|---|---|
all DOM 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 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.
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.
wrapperProps: Object
(optional)Props that are applied to the div which wraps the provided component.
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 (
<CardWithHydrationOnDemand
title="my card"
wrapperProps={{
className: "customClassName",
style: { display: "contents" },
}}
/>
);
}
}
forceHydration: Boolean
(optional, default: false)Force the hydration of the component.
FAQs
Hydrate your React components only when you need to
We found that react-hydration-on-demand demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.