<form> - This feature is available in the latest Canary

Canary

React による <form> の機能拡張は、現在 React の Canary および experimental チャンネルでのみ利用可能です。React の安定版リリースでは、<form> は単なる組み込みのブラウザ HTML コンポーネントとして機能します。React のリリースチャンネルについてはこちらをご覧ください。

ビルトインのブラウザ <form> コンポーネント を使用すると、情報を送信するためのインタラクティブなコントロールを作成できます。

<form action={search}>
<input name="query" />
<button type="submit">Search</button>
</form>

リファレンス

<form>

情報を送信するためのインタラクティブなコントロールを作成するには、ビルトインのブラウザ <form> コンポーネントをレンダーします。

<form action={search}>
<input name="query" />
<button type="submit">Search</button>
</form>

さらに例を見る

props

<form> は、要素の一般的な props をすべてサポートしています。

action:URL または関数。action として URL が渡された場合、フォームは HTML の form コンポーネントと同様に動作します。action として関数が渡された場合、その関数がフォームの送信を処理します。action に渡された関数は非同期でもよく、送信されたフォームの FormData を唯一の引数として呼び出されます。action は、<button>、<input type="submit">、または <input type="image"> コンポーネントの formAction プロパティによって上書きされることがあります。

注意点

  • action または formAction に関数が渡された場合、HTTP メソッドは method の値に関わらず POST になります。

使用法

クライアント上でフォーム送信を処理する

フォームの action プロパティに関数を渡すことで、フォームが送信されたときにその関数が実行されるようにします。この関数には formData が引数として渡されるため、フォームが送信したデータにアクセスできます。これは URL のみを受け付ける本来の HTML action とは異なる、独自の動作です。

export default function Search() {
  function search(formData) {
    const query = formData.get("query");
    alert(`You searched for '${query}'`);
  }
  return (
    <form action={search}>
      <input name="query" />
      <button type="submit">Search</button>
    </form>
  );
}

サーバアクションを使ってフォームの送信を処理する

<form> をレンダーし、入力フィールドと送信ボタンを配置します。フォームが送信されたときに関数を実行するために、サーバアクション(Server Action; 'use server' でマークされた関数)を form の action に渡します。

<form action> にサーバアクションを渡すことで、JavaScript が無効あるいはコードがロードされる前の状態でも、ユーザがフォームを送信できるようになります。これは、接続やデバイスが遅い、または JavaScript が無効になっているユーザにとって有益であり、action に URL を渡したフォームと同様に動作します。

<form> のアクションには hidden となっているフォームフィールドを使ってデータを送信することもできます。サーバアクションは、hidden フィールドのデータも FormData インスタンスに含まれた状態で呼び出されます。

import { updateCart } from './lib.js';

function AddToCart({productId}) {
async function addToCart(formData) {
'use server'
const productId = formData.get('productId')
await updateCart(productId)
}
return (
<form action={addToCart}>
<input type="hidden" name="productId" value={productId} />
<button type="submit">Add to Cart</button>
</form>

);
}

hidden フィールドを使用して <form> アクションにデータを渡す代わりに、bind メソッドを呼び出して追加の引数を渡すこともできます。これにより、渡された引数である formData に加えて新しい引数 (productId) がバインドされます。

import { updateCart } from './lib.js';

function AddToCart({productId}) {
async function addToCart(productId, formData) {
"use server";
await updateCart(productId)
}
const addProductToCart = addToCart.bind(null, productId);
return (
<form action={addProductToCart}>
<button type="submit">Add to Cart</button>
</form>
);
}

サーバコンポーネント によって <form> をレンダーし、<form> の action にサーバアクションを渡すことで、フォームのプログレッシブエンハンスメントが有効になります。

フォームの送信中状態を表示する

フォームが送信されている間に保留 (pending) 状態を表示するには、<form> 内でレンダーされるコンポーネントで useFormStatus フックを呼び出して、返された pending プロパティを読み取ります。

以下では、フォームが送信中であることを表示するために pending プロパティを使用しています。

import { useFormStatus } from "react-dom";
import { submitForm } from "./actions.js";

function Submit() {
  const { pending } = useFormStatus();
  return (
    <button type="submit" disabled={pending}>
      {pending ? "Submitting..." : "Submit"}
    </button>
  );
}

function Form({ action }) {
  return (
    <form action={action}>
      <Submit />
    </form>
  );
}

export default function App() {
  return <Form action={submitForm} />;
}

useFormStatus フックの詳細はリファレンスドキュメントを参照してください。

フォームデータの楽観的更新

useOptimistic フックは、ネットワークリクエストのようなバックグラウンド作業が完了する前に、ユーザインターフェースを楽観的に更新する方法を提供します。フォームにおいては、この技術はアプリをよりレスポンシブに感じさせるために役立ちます。ユーザがフォームを送信した際に、サーバのレスポンスを待たずに、予想される結果を用いてインターフェースを即座に更新しておきます。

例えば、ユーザがフォームにメッセージを入力して送信ボタンを押すと、useOptimistic フックにより、メッセージが実際にサーバに送信される前であっても、リストに “Sending…” というラベル付きでメッセージを即座に表示できるようになります。この「楽観的」アプローチにより、アプリの印象が高速でレスポンシブになります。その後フォームはバックグラウンドでメッセージの実際の送信を試みます。サーバにメッセージが到着したことを確認すると、“Sending…” ラベルが取り除かれます。

import { useOptimistic, useState, useRef } from "react";
import { deliverMessage } from "./actions.js";

function Thread({ messages, sendMessage }) {
  const formRef = useRef();
  async function formAction(formData) {
    addOptimisticMessage(formData.get("message"));
    formRef.current.reset();
    await sendMessage(formData);
  }
  const [optimisticMessages, addOptimisticMessage] = useOptimistic(
    messages,
    (state, newMessage) => [
      ...state,
      {
        text: newMessage,
        sending: true
      }
    ]
  );

  return (
    <>
      {optimisticMessages.map((message, index) => (
        <div key={index}>
          {message.text}
          {!!message.sending && <small> (Sending...)</small>}
        </div>
      ))}
      <form action={formAction} ref={formRef}>
        <input type="text" name="message" placeholder="Hello!" />
        <button type="submit">Send</button>
      </form>
    </>
  );
}

export default function App() {
  const [messages, setMessages] = useState([
    { text: "Hello there!", sending: false, key: 1 }
  ]);
  async function sendMessage(formData) {
    const sentMessage = await deliverMessage(formData.get("message"));
    setMessages([...messages, { text: sentMessage }]);
  }
  return <Thread messages={messages} sendMessage={sendMessage} />;
}

フォーム送信エラーの処理

場合によっては、<form> の action で呼び出された関数がエラーをスローすることがあります。このようなエラーを処理するには、<form> をエラーバウンダリでラップします。<form> の action で呼び出される関数がエラーをスローすると、エラーバウンダリのフォールバックが表示されます。

import { ErrorBoundary } from "react-error-boundary";

export default function Search() {
  function search() {
    throw new Error("search error");
  }
  return (
    <ErrorBoundary
      fallback={<p>There was an error while submitting the form</p>}
    >
      <form action={search}>
        <input name="query" />
        <button type="submit">Search</button>
      </form>
    </ErrorBoundary>
  );
}

JavaScript を使わずにフォーム送信エラーを表示する

プログレッシブエンハンスメントの実現のため JavaScript バンドルが読み込まれる前にフォーム送信エラーメッセージを表示できるようにするには、以下の条件を満たす必要があります。

  1. <form> が サーバコンポーネントによってレンダーされている
  2. <form> の action プロパティに渡される関数がサーバアクションである
  3. useFormState フックを使用してエラーメッセージを表示している

useFormState はサーバアクションと初期 state の 2 つの引数を受け取り、state 変数とアクションの 2 つの値を返します。useFormState が返したアクションは、フォームの action プロパティに渡します。useFormState が返した state 変数は、エラーメッセージを表示するために使用できます。useFormState に渡すサーバアクションが返す値は、state 変数を更新するために使用されます。

import { useFormState } from "react-dom";
import { signUpNewUser } from "./api";

export default function Page() {
  async function signup(prevState, formData) {
    "use server";
    const email = formData.get("email");
    try {
      await signUpNewUser(email);
      alert(`Added "${email}"`);
    } catch (err) {
      return err.toString();
    }
  }
  const [message, formAction] = useFormState(signup, null);
  return (
    <>
      <h1>Signup for my newsletter</h1>
      <p>Signup with the same email twice to see an error</p>
      <form action={formAction} id="signup-form">
        <label htmlFor="email">Email: </label>
        <input name="email" id="email" placeholder="react@example.com" />
        <button>Sign up</button>
        {!!message && <p>{message}</p>}
      </form>
    </>
  );
}

フォームアクションから state を更新する方法については、useFormState のドキュメントを参照してください。

複数の送信タイプを処理する

フォームは、ユーザが押したボタンに基づいて複数の送信アクションを処理するように設計することができます。フォーム内の各ボタンは、props である formAction を指定することで、異なるアクションや振る舞いに関連付けることができます。

ユーザが特定のボタンをタップしてフォームを送信すると、そのボタンの formAction によって定義された対応するアクションが実行されます。例えば、デフォルトでは書いた記事をレビュー用に送信するが、記事を下書きとして保存するための formAction がセットされた別のボタンもある、というフォームを作ることができます。

export default function Search() {
  function publish(formData) {
    const content = formData.get("content");
    const button = formData.get("button");
    alert(`'${content}' was published with the '${button}' button`);
  }

  function save(formData) {
    const content = formData.get("content");
    alert(`Your draft of '${content}' has been saved!`);
  }

  return (
    <form action={publish}>
      <textarea name="content" rows={4} cols={40} />
      <br />
      <button type="submit" name="button" value="submit">Publish</button>
      <button formAction={save}>Save draft</button>
    </form>
  );
}