https://github.com/georgecht/partial-hydrate
Partial React hydration wrapper component based on screen width for faster responsive performances.
https://github.com/georgecht/partial-hydrate
hydrations partial reactjs responsive
Last synced: 6 months ago
JSON representation
Partial React hydration wrapper component based on screen width for faster responsive performances.
- Host: GitHub
- URL: https://github.com/georgecht/partial-hydrate
- Owner: GeorgeCht
- License: mit
- Created: 2024-01-06T19:40:44.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-08-10T14:04:05.000Z (6 months ago)
- Last Synced: 2025-08-10T16:14:17.613Z (6 months ago)
- Topics: hydrations, partial, reactjs, responsive
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/partial-hydrate
- Size: 1.05 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Partial Hydrate [![npm version][npm-image]][npm-url]  [![Downloads][downloads-image]][npm-url] [](https://github.com/actions/checkout/actions/workflows/test.yml)
## Introduction
Provides a `` component that conditionally _skips hydrating children_ by removing them from the DOM _before the first client render_. Removing them before ensures hydration is successful and there are no hydration mismatch errors.
## Install
```
npm i partial-hydrate
```
## Usage
```tsx
{
window.innerWidth <= 680
}}
>
{/* My mobile component */}
```
## Props
- `minWidth`: will render if window width is greater than `minWidth` value.
- `maxWidth`: will render if window width is lesser than `maxWidth` value.
- `when()`: `function` that must return `true` for the render to happen.
### Use with minWidth and/or maxWidth
You can use the `minWidth` and/or `maxWidth` props individually or together to conditionally render components based on the window width. Here's an example:
```tsx
const MyComponent = () => {
return (
{ /* Rendered if window width is greater than or equal to 768 pixels */ }
{ /* Rendered if window width is less than or equal to 1024 pixels */ }
{ /* Rendered if window width is between 768 and 1024 pixels (inclusive) */ }
)
}
```
### Use with when()
The `when()` prop allows for a custom condition based on a function. It is particularly useful for your _dynamic conditions_. For example:
```tsx
const MyComponent = () => {
return (
someDynamicCondition()}>
{/* Rendered if the custom condition specified in the `when()` function is true */}
)
}
```
## Use case
When using React's server-side rendering, we often need to render components on the server even if they are conditional on the client _e.g. hidden based on window width_.
In order for hydration to succeed, the first client render must match the DOM (which is generated from the HTML returned by the server), otherwise we will get hydration mismatch errors. This means the component must be rendered again during the first client render.
However, hydration is expensive, so we really don't want to pay that penalty only for the element to be hidden or removed immediately afterwards.
## Caveats
So is this another react _responsive_ rendering library? Nope. If the prop conditions are not met, then ``'s children are never rendered.
#### ✋ Keep in mind
Also, keep in mind that using `` does not work on window resize and it is not meant to!
## Authors
Based on a gist by [OliverJAsh](https://github.com/OliverJAsh). Developed, modified and maintained by [George Cht](https://github.com/GeorgeCht).
- George Cht ([@GeorgeCht](https://github.com/GeorgeCht))
- Oliver Joseph Ash ([@OliverJAsh](https://github.com/OliverJAsh))
## License
[MIT License](https://opensource.org/licenses/MIT)
[downloads-image]: http://img.shields.io/npm/dm/partial-hydrate.svg
[npm-url]: https://www.npmjs.com/package/partial-hydrate
[npm-image]: http://img.shields.io/npm/v/partial-hydrate.svg