グローバル設定

コンテキストSWRConfigは、すべてのSWRフックに対してグローバル設定（オプション）を提供できます。

<SWRConfig value={options}>
  <Component/>
</SWRConfig>

この例では、すべてのSWRフックはJSONデータの読み込みに提供された同じフェッチャーを使用し、デフォルトで3秒ごとに更新されます。

import useSWR, { SWRConfig } from 'swr'
 
function Dashboard () {
  const { data: events } = useSWR('/api/events')
  const { data: projects } = useSWR('/api/projects')
  const { data: user } = useSWR('/api/user', { refreshInterval: 0 }) // override
 
  // ...
}
 
function App () {
  return (
    <SWRConfig 
      value={{
        refreshInterval: 3000,
        fetcher: (resource, init) => fetch(resource, init).then(res => res.json())
      }}
    >
      <Dashboard />
    </SWRConfig>
  )
}

ネストされた設定

SWRConfigは、親コンテキストからの設定をマージします。オブジェクトまたは関数型設定のいずれかを受け取ります。関数型設定は、親設定を引数として受け取り、自分でカスタマイズできる新しい設定を返します。

オブジェクト設定の例

import { SWRConfig, useSWRConfig } from 'swr'
 
function App() {
  return (
    <SWRConfig
      value={{
        dedupingInterval: 100,
        refreshInterval: 100,
        fallback: { a: 1, b: 1 },
      }}
    >
      <SWRConfig
        value={{
          dedupingInterval: 200, // will override the parent value since the value is primitive
          fallback: { a: 2, c: 2 }, // will merge with the parent value since the value is a mergeable object
        }}
      >
        <Page />
      </SWRConfig>
    </SWRConfig>
  )
}
 
function Page() {
  const config = useSWRConfig()
  // {
  //   dedupingInterval: 200,
  //   refreshInterval: 100,
  //   fallback: { a: 2,  b: 1, c: 2 },
  // }
}

関数型設定の例

import { SWRConfig, useSWRConfig } from 'swr'
 
function App() {
  return (
    <SWRConfig
      value={{
        dedupingInterval: 100,
        refreshInterval: 100,
        fallback: { a: 1, b: 1 },
      }}
    >
      <SWRConfig
        value={parent => ({
          dedupingInterval: parent.dedupingInterval * 5,
          fallback: { a: 2, c: 2 },
        })}
      >
        <Page />
      </SWRConfig>
    </SWRConfig>
  )
}
 
function Page() {
  const config = useSWRConfig()
  // {
  //   dedupingInterval: 500,
  //   fallback: { a: 2, c: 2 },
  // }
}

追加のAPI

キャッシュプロバイダー

リストされているすべてのオプションに加えて、SWRConfigは、オプションのprovider関数も受け入れます。キャッシュセクションで詳細を参照してください。

<SWRConfig value={{ provider: () => new Map() }}>
  <Dashboard />
</SWRConfig>

グローバル設定へのアクセス

useSWRConfigフックを使用してグローバル設定を取得できます。mutateとcacheも同様です。

import { useSWRConfig } from 'swr'
 
function Component () {
  const { refreshInterval, mutate, cache, ...restConfig } = useSWRConfig()
 
  // ...
}

ネストされた設定は拡張されます。<SWRConfig>を使用しない場合、デフォルトの設定が返されます。

API データ取得