docs: add changeset for zustand sync progress (#1931)

latticexyz · Nov 13, 2023 · 7eabd06 · 7eabd06
1 parent 2b3c948
commit 7eabd06
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/.changeset/tricky-gifts-compare.md b/.changeset/tricky-gifts-compare.md
@@ -0,0 +1,13 @@
+---
+"@latticexyz/store-sync": minor
+---
+
+Added and populated `syncProgress` key in Zustand store for sync progress, like we do for RECS sync. This will let apps using `syncToZustand` render a loading state while initial client hydration is in progress.
+
+```tsx
+const syncProgress = useStore((state) => state.syncProgress);
+
+if (syncProgress.step !== SyncStep.LIVE) {
+  return <>Loading ({Math.floor(syncProgress.percentage)}%)</>;
+}
+```