docs: add useLayoutEffect warning mitigation (#944)

pmndrs · Sep 2, 2024 · d5c06fc · d5c06fc
1 parent 7734e7b
commit d5c06fc
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/guides/migrating-to-v2.mdx b/docs/guides/migrating-to-v2.mdx
@@ -102,6 +102,19 @@ state.obj = deepClone(newObj)
 // and do something later with `newObj`
 ```
 
+### `useLayoutEffect` server warning
+
+If you're using React 18 with SSR, add this conditional to prevent excessive warnings.
+
+```js
+import { snapshot, useSnapshot as useSnapshotOrig } from 'valtio'
+
+const isSSR = typeof window === 'undefined'
+export const useSnapshot = isSSR ? (p) => snapshot(p) : useSnapshotOrig
+
+// render with `useSnapshot` as usual
+```
+
 ## Links
 
 - https://github.com/pmndrs/valtio/discussions/703