Reactで、複数タブのlocalStorageの値をそろえる方法

​​React​localStorage,Playwright,TypeScript,useSyncExternalStore,カスタムフック

localStorage に保存した値を、同じサイトを開いているほかのタブにもすぐ反映するには、ブラウザの storage イベントを useSyncExternalStore で購読します。文字の大きさやダークモードのような表示設定を、1つのタブで変えたら、開いているほかのタブも同じ表示にそろえたい場面で使えます。

ただし、storage イベントは書き換えたタブ自身には届きません。この記事のフックは、自分のタブには自分で知らせ、ほかのタブの変更は storage イベントで受け取ります。私は検証環境で2つのタブを開き、値がそろうこと、イベントが届く条件、まちがえやすい書き方で起きることを確かめました。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4、React / react-dom 19.3.1、TypeScript 7.0.2 です。コードは tsc で型チェックしてから esbuild でまとめ、StrictMode で囲んだ開発ビルドを、Chromium 153 を Playwright 1.63.0 で操作して開きました。2つのタブは、Playwright の同じブラウザコンテキストで開いた2つのページです。まちがえた書き方の2つの例は、StrictMode で囲まずに開きました。Firefox や Safari、スマートフォンのブラウザ、別のウィンドウやブラウザのプロファイルをまたぐ場合、Next.js などのフレームワークの上での動きは試していません。

上のタブで「大きく」を3回押すと、下のタブの文字の大きさも同じように変わる
上がタブA、下がタブB。タブAで「大きく」を押すたびに、タブBの数字と見本の文章も storage イベントで変わる。カーソルと回数の表示は、あとから重ねたもの

storage イベントは、ほかのタブにだけ届く

MDN の storage イベントのページによると、このイベントは、同じオリジンのほかのタブなどが localStorage を書き換えたときに届きます。書き換えたタブ自身には届きません。

検証環境でも、タブAで値を書き換えると、イベントはタブBにだけ届き、タブAには届きませんでした。タブBに届いたイベントは次のとおりです。

text
B に届いたイベント [
  {
    key: 'settings',
    oldValue: null,
    newValue: '{"fontSize":18,"compact":false}',
    area: 'local'
  }
]

イベントが届くかどうかと、key・newValue の中身は、書き換え方によって変わりました。いずれも、HTML の仕様にある setItem() などの手順のとおりです。

タブAでしたこと タブBに届いたイベント
setItem() で値を変える key は変えたキー、newValue は新しい値
今と同じ値で setItem() を呼ぶ 届かない
removeItem() で消す newValue が null
clear() ですべて消す key・oldValue・newValue がすべて null
sessionStorage に書き込む 届かない

clear() では key が null になるので、「自分のキーのときだけ読み直す」という条件を e.key === key だけで書くと、すべて消されたことに気づけません。この記事のフックは、キーで絞らずに、イベントが届いたら localStorage から読み直すことにしました。値が同じなら描き直さない理由は、後の節で説明します。

localStorage を読むフック

フックの全体は次のとおりです。値は JSON にして保存します。

ts
import { useCallback, useMemo, useSyncExternalStore } from 'react';

// 同じタブの中で書き換えたことを知らせる相手
const listeners = new Set<() => void>();

function subscribe(listener: () => void) {
  listeners.add(listener);
  // ほかのタブで書き換えられたときは storage イベントが届く
  const onStorage = (e: StorageEvent) => {
    if (e.storageArea === localStorage) listener();
  };
  window.addEventListener('storage', onStorage);
  return () => {
    listeners.delete(listener);
    window.removeEventListener('storage', onStorage);
  };
}

function notify() {
  for (const l of listeners) l();
}

function readRaw(key: string): string | null {
  try {
    return localStorage.getItem(key);
  } catch {
    return null;
  }
}

export function useLocalStorage<T>(key: string, initial: T) {
  // スナップショットは文字列のまま返す(毎回同じ値なら描き直さない)
  const raw = useSyncExternalStore(
    subscribe,
    () => readRaw(key),
    () => null,
  );

  const value = useMemo<T>(() => {
    if (raw === null) return initial;
    try {
      return JSON.parse(raw) as T;
    } catch {
      return initial;
    }
    // initial は変わらない値(モジュールの定数など)を渡す前提
  }, [raw]);

  const setValue = useCallback(
    (next: T) => {
      try {
        localStorage.setItem(key, JSON.stringify(next));
      } catch {
        // 容量不足などで保存できなかった
      }
      // 自分のタブには storage イベントが届かないので、自分で知らせる
      notify();
    },
    [key],
  );

  const remove = useCallback(() => {
    try {
      localStorage.removeItem(key);
    } catch {
      // localStorage が使えない
    }
    notify();
  }, [key]);

  return [value, setValue, remove] as const;
}

useSyncExternalStore には、購読する関数(subscribe)と、今の値を返す関数(getSnapshot)を渡します。公式リファレンスにも、navigator.onLine のように、値が変わるとイベントで知らせるブラウザの API を購読する例が載っています。

subscribe は、ほかのタブの変更を受け取る storage イベントと、同じタブの変更を受け取る listeners の両方に、React から渡された関数を登録します。setValue と remove は、localStorage に書いたあと notify() で同じタブのコンポーネントに知らせます。subscribe はコンポーネントの外に置いています。公式リファレンスによると、描画のたびに違う subscribe を渡すと、React はそのたびに購読し直します。

e.storageArea === localStorage の条件は、sessionStorage の変更を無視するためのものです。MDN のページによると、同じタブに同じオリジンの iframe があると、その中で sessionStorage を書き換えたときにも storage イベントが届きます。

使う側では、useState と同じような形で読み書きできます。同じタブの中で、2つのコンポーネントが同じキーを読んでいても、どちらも同じ値になります。

tsx
type Settings = { fontSize: number; compact: boolean };
const DEFAULT: Settings = { fontSize: 16, compact: false };

function SettingsPanel() {
  const [settings, setSettings, reset] = useLocalStorage<Settings>('settings', DEFAULT);
  return (
    <section>
      <p>文字の大きさ:{settings.fontSize}px</p>
      <button onClick={() => setSettings({ ...settings, fontSize: settings.fontSize + 2 })}>大きく</button>
      <label>
        <input
          type="checkbox"
          checked={settings.compact}
          onChange={(e) => setSettings({ ...settings, compact: e.target.checked })}
        />
        詰めて表示する
      </label>
      <button onClick={reset}>元に戻す</button>
    </section>
  );
}

function Preview() {
  const [settings] = useLocalStorage<Settings>('settings', DEFAULT);
  return (
    <p style={{ fontSize: settings.fontSize, lineHeight: settings.compact ? 1.2 : 1.8 }}>
      見本の文章です。
    </p>
  );
}

検証で使ったコードには、このほかに見出しと「小さく」ボタンもあります。検証環境で2つのタブを開き、タブAで「大きく」を押すと、タブAとタブBのどちらでも、SettingsPanel と Preview が 18px になりました。タブBで「詰めて表示する」のチェックを入れると、今度はタブAにだけイベントが届き、タブAのチェックも入りました。「元に戻す」を押すと、どちらのタブも初期値の 16px に戻りました。

フックを通さずに書き換えた変更は、同じタブには反映されません。20px のときに、タブAのページの中で直接 localStorage.clear() を実行すると、タブBは 16px に戻りましたが、タブAは 20px のままでした。MDN にあるとおりタブAには storage イベントが届かず、notify() も呼ばれないためです。

自分のタブに知らせないと、押しても表示が変わらない

storage イベントだけを購読し、書き込んだあとに notify() を呼ばない書き方では、操作したタブの表示が変わりません。次のコードで試しました。

tsx
function subscribe(listener: () => void) {
  window.addEventListener('storage', listener);
  return () => window.removeEventListener('storage', listener);
}

function App() {
  const raw = useSyncExternalStore(subscribe, () => localStorage.getItem('count'));
  const count = Number(raw ?? '0');
  return (
    <>
      <output>{count}</output>
      <button onClick={() => localStorage.setItem('count', String(count + 1))}>増やす</button>
    </>
  );
}

タブAで「増やす」を3回押した結果です。

text
タブAで1回目のクリック: A の表示=0 A の保存値=1 B の表示=1
タブAで2回目のクリック: A の表示=0 A の保存値=1 B の表示=1
タブAで3回目のクリック: A の表示=0 A の保存値=1 B の表示=1

ほかのタブ(B)には storage イベントが届くので、1 が表示されました。押したタブ(A)は描き直されないので 0 のままです。描画に使った count も 0 のままなので、2回目以降も同じ 1 を書き込むことになり、保存された値も 1 から増えませんでした。

getSnapshot の中で JSON.parse すると、無限ループになる

オブジェクトを保存しているとき、getSnapshot の中で JSON.parse してオブジェクトを返したくなります。しかし、この書き方は動きません。

tsx
// まちがい:読むたびに JSON.parse するので、毎回新しいオブジェクトになる
function getSnapshot() {
  return JSON.parse(localStorage.getItem('settings') ?? '{"fontSize":16}') as { fontSize: number };
}

検証環境で開くと、画面には何も表示されず、コンソールに次のエラーが出ました。

text
The result of getSnapshot should be cached to avoid an infinite loop
Maximum update depth exceeded. This can happen when a component repeatedly calls setState inside componentWillUpdate or componentDidUpdate. React limits the number of nested updates to prevent infinite loops.

公式リファレンスのこのエラーの説明にあるとおり、React は getSnapshot の戻り値が前回と違えば描き直します。JSON.parse は呼ぶたびに新しいオブジェクトを作るので、値が変わっていなくても毎回「違う」と判断されます。

この記事のフックでは、getSnapshot は localStorage の文字列をそのまま返し、JSON.parse は useMemo の中で行っています。公式リファレンスによると、React は getSnapshot の戻り値を Object.is で比べ、前回と同じなら描き直しません。中身が同じ文字列は Object.is で同じ値になるので、ほかのタブで別のキーが変わってイベントが届いても、このコンポーネントは描き直されません。

ポイント

getSnapshot からは、localStorage の文字列(または null)をそのまま返します。オブジェクトに直すのは、文字列が変わったときだけにします。

値が壊れていても、保存に失敗しても、画面を止めない

localStorage の値は、ほかのタブや古いバージョンのコードが書いた値のこともあります。検証環境で、タブAで 20px にしてから、タブAから '{broken' という JSON として読めない値を書き込みました。タブBは JSON.parse の失敗を catch して初期値の 16px を表示し、コンソールにエラーは出ませんでした。

書き込みも失敗することがあります。仕様では、保存できない値の setItem() は QuotaExceededError を投げることになっています。検証環境の Chromium で 6MB の文字列を setItem() すると、QuotaExceededError が投げられました。フックの setValue は setItem() を try〜catch で囲んでいるので、保存に失敗しても例外がクリックの処理の外に出ず、notify() まで進みます。

サーバーで描く場合は、最初は初期値が表示される

useSyncExternalStore の3つ目の引数(getServerSnapshot)は、サーバーで描くときと、その HTML をブラウザでハイドレーションするときに使われます(公式リファレンス)。サーバーには localStorage がないので、このフックでは null を返し、初期値で描きます。

検証環境では、renderToString で作った HTML を、localStorage に 24px を保存したタブで開きました。JavaScript が動く前の HTML は 16px で、ハイドレーションのあとに 24px に変わりました。コンソールに、ハイドレーションの食い違いのエラーは出ませんでした。ハイドレーションが終わるまでは、保存した値ではなく、初期値の 16px が表示されます。

​Posted by 86