Skip to content

docs(code-page): add 'apollo-state-sync' JavaScript client #2526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sdev-buildz wants to merge 1 commit into
base: source
Choose a base branch
from
Open

docs(code-page): add 'apollo-state-sync' JavaScript client #2526

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions src/code/language-support/javascript/client/apollo-state-sync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Apollo State Sync
description: Seamlessly synchronize and persist Apollo Client cache and reactive variables across multiple browser tabs and windows for a consistent user experience.
github: sdev-buildz/apollo-state-sync
npm: apollo-state-sync
tags:
- tools-and-libraries
- frontend
---

## 💡 Why use it?

Modern web apps often run across multiple browser tabs or windows within the same workflow. Without shared state synchronization, users can end up with inconsistent data:

- logged in status differs across tabs
- Data edited in one tab stays outdated in another until a manual refresh.
- in-memory caches are inconsistent across tabs
- app state resets unexpectedly when a tab is reopened

<br/>

## ✨ Features

- Syncs Apollo Client's state (Apollo cache and reactive variables) across all browser tabs and windows.
- Persists state across browser restarts and user sessions
- Helps build multi-window and multi-tab apps without custom state plumbing

<br/>

## 🔌 API reference

- 🚀 **Quick Start**: Jump into the [API Overview](https://github.com/sdev-buildz/apollo-state-sync/blob/6cd9a05467ade3a31ac0350aa9fe7cad3c3ae760/API_OVERVIEW.md) to get up and running in minutes.
- 🤖 **Automated Migration**: Effortlessly transition from standard Apollo Client using the [Migration Bot](https://github.com/sdev-buildz/apollo-state-sync/blob/6cd9a05467ade3a31ac0350aa9fe7cad3c3ae760/README.md#-migration-automation).

<br/>

## 📽️ See it in Action

[<img alt="demo video" width="240px" src="https://raw.githubusercontent.com/sdev-buildz/apollo-state-sync/refs/heads/main/assets/Shopping%20Site%20Example%20-%20Demo%20Thumbnail.png"/>](https://github.com/user-attachments/assets/18df5e73-f7a6-417f-8398-2bb8251ccc3e)

<br/>

### 🌐 Try the Live Demo

You can access the live application here: https://sdev-buildz.github.io/apollo-state-sync/examples/posts
Loading