React Router v7 ドキュメント 日本語版

English

Fetcher の使用

Fetcher は、ナビゲーションを発生させることなく、複数の同時データ操作を必要とする複雑で動的なユーザーインターフェースを作成するのに役立ちます。

Fetcher は、独自の独立した状態を追跡し、データのロード、データの変更、フォームの送信、および一般的にローダーやアクションとの対話に使用できます。

アクションの呼び出し

Fetcher の最も一般的なケースは、アクションにデータを送信し、ルートデータの再検証をトリガーすることです。次のルートモジュールを考えてみましょう。

import { useLoaderData } from "react-router";
 
export async function clientLoader({ request }) {
  let title = localStorage.getItem("title") || "No Title";
  return { title };
}
 
export default function Component() {
  let data = useLoaderData();
  return (
    <div>
      <h1>{data.title}</h1>
    </div>
  );
}

1. アクションを追加する

まず、Fetcher が呼び出すアクションをルートに追加します。

import { useLoaderData } from "react-router";
 
export async function clientLoader({ request }) {
  // ...
}
 
export async function clientAction({ request }) {
  await new Promise((res) => setTimeout(res, 1000));
  let data = await request.formData();
  localStorage.setItem("title", data.get("title"));
  return { ok: true };
}
 
export default function Component() {
  let data = useLoaderData();
  // ...
}

2. Fetcher を作成する

次に、Fetcher を作成し、それを使用してフォームをレンダリングします。

import { useLoaderData, useFetcher } from "react-router";
 
// ...
 
export default function Component() {
  let data = useLoaderData();
  let fetcher = useFetcher();
  return (
    <div>
      <h1>{data.title}</h1>
 
      <fetcher.Form method="post">
        <input type="text" name="title" />
      </fetcher.Form>
    </div>
  );
}

3. フォームを送信する

ここでフォームを送信すると、Fetcher はアクションを呼び出し、ルートデータを自動的に再検証します。

4. 保留中の状態をレンダリングする

Fetcher は、非同期処理中にその状態を利用できるようにするため、ユーザーが操作した瞬間に保留中の UI をレンダリングできます。

export default function Component() {
  let data = useLoaderData();
  let fetcher = useFetcher();
  return (
    <div>
      <h1>{data.title}</h1>
 
      <fetcher.Form method="post">
        <input type="text" name="title" />
        {fetcher.state !== "idle" && <p>Saving...</p>}
      </fetcher.Form>
    </div>
  );
}

5. 楽観的な UI

フォームに次の状態をすぐにレンダリングするのに十分な情報がある場合があります。fetcher.formData を使用してフォームデータにアクセスできます。

export default function Component() {
  let data = useLoaderData();
  let fetcher = useFetcher();
  let title = fetcher.formData?.get("title") || data.title;
 
  return (
    <div>
      <h1>{title}</h1>
 
      <fetcher.Form method="post">
        <input type="text" name="title" />
        {fetcher.state !== "idle" && <p>Saving...</p>}
      </fetcher.Form>
    </div>
  );
}

6. Fetcher データと検証

アクションから返されたデータは、Fetcher の data プロパティで利用できます。これは主に、失敗した変更のエラーメッセージをユーザーに返すのに役立ちます。

// ...
 
export async function clientAction({ request }) {
  await new Promise((res) => setTimeout(res, 1000));
  let data = await request.formData();
 
  let title = data.get("title") as string;
  if (title.trim() === "") {
    return { ok: false, error: "Title cannot be empty" };
  }
 
  localStorage.setItem("title", title);
  return { ok: true, error: null };
}
 
export default function Component() {
  let data = useLoaderData();
  let fetcher = useFetcher();
  let title = fetcher.formData?.get("title") || data.title;
 
  return (
    <div>
      <h1>{title}</h1>
 
      <fetcher.Form method="post">
        <input type="text" name="title" />
        {fetcher.state !== "idle" && <p>Saving...</p>}
        {fetcher.data?.error && (
          <p style={{ color: "red" }}>
            {fetcher.data.error}
          </p>
        )}
      </fetcher.Form>
    </div>
  );
}

データのロード

Fetcher のもう 1 つの一般的なユースケースは、コンボボックスのようなもののためにルートからデータをロードすることです。

1. 検索ルートを作成する

非常に基本的な検索を備えた次のルートを考えてみましょう。

./search-users.tsx
// { path: '/search-users', filename: './search-users.tsx' }
const users = [
  { id: 1, name: "Ryan" },
  { id: 2, name: "Michael" },
  // ...
];
 
export async function loader({ request }) {
  await new Promise((res) => setTimeout(res, 300));
  let url = new URL(request.url);
  let query = url.searchParams.get("q");
  return users.filter((user) =>
    user.name.toLowerCase().includes(query.toLowerCase())
  );
}

2. コンボボックスコンポーネントで Fetcher をレンダリングする

import { useFetcher } from "react-router";
 
export function UserSearchCombobox() {
  let fetcher = useFetcher();
  return (
    <div>
      <fetcher.Form method="get" action="/search-users">
        <input type="text" name="q" />
      </fetcher.Form>
    </div>
  );
}
  • アクションは、上記で作成したルート "/search-users" を指します。
  • 入力の名前は、クエリパラメータと一致するように "q" です。

3. 型推論を追加する

import { useFetcher } from "react-router";
import type { Search } from "./search-users";
 
export function UserSearchCombobox() {
  let fetcher = useFetcher<typeof Search.action>();
  // ...
}

型のみをインポートするように import type を使用してください。

4. データをレンダリングする

import { useFetcher } from "react-router";
 
export function UserSearchCombobox() {
  let fetcher = useFetcher<typeof Search.action>();
  return (
    <div>
      <fetcher.Form method="get" action="/search-users">
        <input type="text" name="q" />
      </fetcher.Form>
      {fetcher.data && (
        <ul>
          {fetcher.data.map((user) => (
            <li key={user.id}>{user.name}</li>
          ))}
        </ul>
      )}
    </div>
  );
}

フォームを送信して結果を表示するには、「Enter」キーを押す必要があることに注意してください。

5. 保留中の状態をレンダリングする

import { useFetcher } from "react-router";
 
export function UserSearchCombobox() {
  let fetcher = useFetcher<typeof Search.action>();
  return (
    <div>
      <fetcher.Form method="get" action="/search-users">
        <input type="text" name="q" />
      </fetcher.Form>
      {fetcher.data && (
        <ul
          style={{
            opacity: fetcher.state === "idle" ? 1 : 0.25,
          }}
        >
          {fetcher.data.map((user) => (
            <li key={user.id}>{user.name}</li>
          ))}
        </ul>
      )}
    </div>
  );
}

6. ユーザー入力で検索する

Fetcher は、fetcher.submit を使用してプログラムで送信できます。

<fetcher.Form method="get" action="/search-users">
  <input
    type="text"
    name="q"
    onChange={(event) => {
      fetcher.submit(event.currentTarget.form);
    }}
  />
</fetcher.Form>

入力イベントのフォームが fetcher.submit の最初の引数として渡されることに注意してください。Fetcher は、そのフォームを使用してリクエストを送信し、その属性を読み取り、その要素からデータをシリアル化します。