アクション
このページの内容

アクション

データの変更は、ルートアクションを通じて行われます。アクションが完了すると、ページ上のすべてのローダーデータが再検証され、UIを同期させるためのコードを記述する必要なく、UIがデータと同期した状態に保たれます。

actionで定義されたルートアクションはサーバー上でのみ呼び出され、clientActionで定義されたアクションはブラウザーで実行されます。

クライアントアクション

クライアントアクションはブラウザーでのみ実行され、両方が定義されている場合は、サーバーアクションよりも優先されます。

// route('/projects/:projectId', './project.tsx')
import type { Route } from "./+types/project";
import { Form } from "react-router";
import { someApi } from "./api";

export async function clientAction({
  request,
}: Route.ClientActionArgs) {
  let formData = await request.formData();
  let title = await formData.get("title");
  let project = await someApi.updateProject({ title });
  return project;
}

export default function Project({
  actionData,
}: Route.ComponentProps) {
  return (
    <div>
      <h1>Project</h1>
      <Form method="post">
        <input type="text" name="title" />
        <button type="submit">Submit</button>
      </Form>
      {actionData ? (
        <p>{actionData.title} updated</p>
      ) : null}
    </div>
  );
}

サーバーアクション

サーバーアクションはサーバー上でのみ実行され、クライアントバンドルから削除されます。

// route('/projects/:projectId', './project.tsx')
import type { Route } from "./+types/project";
import { Form } from "react-router";
import { fakeDb } from "../db";

export async function action({
  request,
}: Route.ActionArgs) {
  let formData = await request.formData();
  let title = await formData.get("title");
  let project = await fakeDb.updateProject({ title });
  return project;
}

export default function Project({
  actionData,
}: Route.ComponentProps) {
  return (
    <div>
      <h1>Project</h1>
      <Form method="post">
        <input type="text" name="title" />
        <button type="submit">Submit</button>
      </Form>
      {actionData ? (
        <p>{actionData.title} updated</p>
      ) : null}
    </div>
  );
}

アクションの呼び出し

アクションは、ルートのパスと "post" メソッドを参照することで、<Form> を通して宣言的に、また useSubmit (または <fetcher.Form>fetcher.submit)を通して命令的に呼び出されます。

Form を使用したアクションの呼び出し

import { Form } from "react-router";

function SomeComponent() {
  return (
    <Form action="/projects/123" method="post">
      <input type="text" name="title" />
      <button type="submit">Submit</button>
    </Form>
  );
}

これによりナビゲーションが発生し、ブラウザの履歴に新しいエントリが追加されます。

useSubmit を使用したアクションの呼び出し

useSubmit を使用すると、フォームデータをアクションに命令的に送信できます。

import { useCallback } from "react";
import { useSubmit } from "react-router";
import { useFakeTimer } from "fake-lib";

function useQuizTimer() {
  let submit = useSubmit();

  let cb = useCallback(() => {
    submit(
      { quizTimedOut: true },
      { action: "/end-quiz", method: "post" }
    );
  }, []);

  let tenMinutes = 10 * 60 * 1000;
  useFakeTimer(tenMinutes, cb);
}

これによりナビゲーションが発生し、ブラウザの履歴に新しいエントリが追加されます。

fetcher を使用したアクションの呼び出し

fetcher を使用すると、(ブラウザの履歴に新しいエントリを追加することなく)ナビゲーションを引き起こすことなく、アクション(およびローダー)にデータを送信できます。

import { useFetcher } from "react-router";

function Task() {
  let fetcher = useFetcher();
  let busy = fetcher.state !== "idle";

  return (
    <fetcher.Form method="post" action="/update-task/123">
      <input type="text" name="title" />
      <button type="submit">
        {busy ? "Saving..." : "Save"}
      </button>
    </fetcher.Form>
  );
}

また、命令的な submit メソッドも持っています。

fetcher.submit(
  { title: "New Title" },
  { action: "/update-task/123", method: "post" }
);

詳細については、Fetchers の使用ガイドを参照してください。


次へ: ナビゲーション

ドキュメントと例 CC 4.0