React Breakpoints

---

react-breakpoints allows you to respond to changes in a DOM element's size. You can change the evaluated logic and rendered output of components based on observed size changes in DOM elements. For example, you can change a dropdown menu to a horizontal list menu based on its parent container's width without using CSS media queries.

📦 What's in the box?

> No polling. No event listening. No sentinel elements. Just a ResizeObserver!

This package provides you with:

- a to instantiate the ResizeObserver;
- an component to observe changes in a DOM element and respond to them.

For power users this package also provides:

- a useBreakpoints() hook to change a component's behaviour based on the observed size information in the nearest parent ;
- a useResizeObserver() hook to connect a DOM element in your component to the instantiated ResizeObserver on ;
- a useResizeObserverEntry() hook to retrieve the ResizeObserverEntry put on the nearest . This is what useBreakpoints() uses under the hood.

🐉 Be careful using this package when…

- …all you want is the low-level API stuff. See @envato/react-resize-observer-hook.
- …you want _real_ CSS Element Queries. At the end of the day, this is still a JS solution.
- …you care deeply about Cumulative Layout Shift on public pages. Keep reading though, this package may still be of value to you!

🏅 This package is _really good_ at…

- …following the latest draft spec, giving you access to cutting edge features like devicePixelContentBoxSize and per-fragment observation.
- …performantly observing many elements with a single ResizeObserver instance. None of that "a new ResizeObserver instance per observed element" bloat that some alternative packages implement.
- …building highly-responsive private dashboards 📊. One key thing this package (and every other ResizeObserver package out there) can contribute negatively to is Cumulative Layout Shifting. At Envato we've had great success using this package on pages that are only visible after signing in, like our Author Dashboard. We've had less success using it in places where search engines can go, on components with responsive styles that changed the layout vertically. One of our company values is "Tell It Like It Is", so we're letting you know to be mindful of when and how you use ResizeObserver for responsive layouts.

⚡️ Quick start

Follow these minimum required steps to get started with react-breakpoints. This is just the tip of the iceberg, though. Check the API Docs for all options.

``shell
npm install @envato/react-breakpoints
`

Wrap your component tree with the provider

`jsx
import { Provider as ResizeObserverProvider } from '@envato/react-breakpoints';

const App = () => ...;
`

⚠️ Caution — You may need to pass some props to to increase browser support. Please refer to the API Docs.

Observe an element and use the results

`jsx
import { Observe } from '@envato/react-breakpoints';

const exampleBreakpoints = {
widths: {
0: 'mobile',
769: 'tablet',
1025: 'desktop'
}
};

export const ExampleComponent = () => (

{({ observedElementProps, widthMatch = 'ssr' }) => (