Skip to main content

Browser Only

A wrapper component that renders its children in the browser only, after hydration completes.

When to use

  • Render children that rely on browser-only APIs, such as window, document, localStorage, or media queries.

API Reference

BrowserOnly

PropTypeDefaultDescription
children() => ReactNodeChildren must be a render function so that evaluation is deferred until after hydration has occurred.
fallback?ReactNodenullOptional fallback to render on the server (and during hydration) before the client-only children are mounted. Ideally, this should be the same dimensions as the eventual children to avoid layout shift.

canUseDOM

canUseDOM(): boolean returns true when window and document exist. Use it to guard a DOM API call that runs outside a component, such as a localStorage read in a loader.

import { canUseDOM } from "@ngrok/mantle/browser-only"; if (canUseDOM()) {	localStorage.setItem("foo", "bar");}