<Form>

<Form>コンポーネントは、HTMLの<form>要素を拡張して、プリフェッチによるローディングUI、 送信時のクライアントサイドナビゲーション、およびプログレッシブエンハンスメントを提供します。

URL検索パラメータを更新するフォームに役立ちます。上記の機能を実現するために必要なボイラープレートコードを削減できます。

基本的な使用方法

import Form from 'next/form'
 
export default function Page() {
  return (
    <Form action="/search">
      {/* On submission, the input value will be appended to 
          the URL, e.g. /search?query=abc */}
      <input name="query" />
      <button type="submit">Submit</button>
    </Form>
  )
}

リファレンス

<Form>コンポーネントの動作は、actionプロップにstring型とfunction型どちらが渡されるかによって異なります。

• actionが文字列の場合、<Form>は、GETメソッドを使用するネイティブのHTMLフォームのように動作します。フォームデータはURLに検索パラメータとしてエンコードされ、フォームが送信されると、指定されたURLにナビゲートします。さらに、Next.jsは
  • プリフェッチをフォームが表示されると実行します。これにより、共有UI（例：layout.jsとloading.js）が事前に読み込まれ、ナビゲーションが高速化されます。
  • フォームが送信されると、完全なページの再読み込みではなく、クライアントサイドナビゲーションを実行します。これにより、共有UIとクライアントサイドの状態が保持されます。
• actionが関数（サーバーアクション）の場合、<Form>はReactフォームのように動作し、フォームが送信されるとアクションを実行します。

action（文字列）プロップ

actionが文字列の場合、<Form>コンポーネントは以下のプロップをサポートします。

• action: フォームが送信されたときにナビゲートするURLまたはパス。
  • 空文字列""は、更新された検索パラメータを使用して同じルートにナビゲートします。
• replace: ブラウザの履歴スタックに新しい履歴状態を追加するのではなく、現在の履歴状態を置き換えます。デフォルトはfalseです。
• scroll: ナビゲーション中のスクロール動作を制御します。デフォルトはtrueで、新しいルートのトップにスクロールし、前後へのナビゲーションではスクロール位置を維持します。
• prefetch: フォームがユーザーのビューポートに表示されたときに、パスをプリフェッチするかどうかを制御します。デフォルトはtrueです。

action (関数) プロパティ

actionが関数の場合、<Form>コンポーネントは次のプロパティをサポートします。

• action: フォームが送信されたときに呼び出されるサーバーアクションです。詳細はReact ドキュメントを参照してください。

補足事項: actionが関数の時、replaceとscrollプロパティは無視されます。

注意事項

• formAction: <button>または<input type="submit">フィールドでactionプロパティを上書きするために使用できます。Next.jsはクライアントサイドのナビゲーションを実行しますが、このアプローチはプリフェッチをサポートしません。
  • basePathを使用する場合は、formActionパスにも含める必要があります。例: formAction="/base-path/search"。
• key: 文字列のactionにkeyプロパティを渡すことはサポートされていません。再レンダリングをトリガーしたり、ミューテーションを実行したい場合は、代わりに関数actionを使用してください。

• onSubmit: フォーム送信ロジックを処理するために使用できます。ただし、event.preventDefault()を呼び出すと、指定されたURLへのナビゲーションなど、<Form>の動作が上書きされます。
• method, encType, target: これらは<Form>の動作を上書きするため、サポートされていません。
  • 同様に、formMethod、formEncType、formTargetはそれぞれmethod、encType、targetプロパティを上書きするために使用でき、それらを使用するとネイティブブラウザの動作に戻ります。
  • これらのプロパティを使用する必要がある場合は、HTMLの<form>要素を使用してください。
• <input type="file">: actionが文字列の場合、この入力タイプを使用すると、ファイルオブジェクトではなくファイル名が送信されるというブラウザの動作と一致します。

例

検索結果ページに進む検索フォーム

パスをactionとして渡すことで、検索結果ページに移動する検索フォームを作成できます。

import Form from 'next/form'
 
export default function Page() {
  return (
    <Form action="/search">
      <input name="query" />
      <button type="submit">Submit</button>
    </Form>
  )
}

ユーザーがクエリ入力フィールドを更新してフォームを送信すると、フォームデータはURLに検索パラメータとしてエンコードされます（例：/search?query=abc）。

補足事項: actionに空文字列""を渡すと、フォームは更新された検索パラメータを持つ同じルートに移動します。

結果ページでは、searchParams page.jsプロパティを使用してクエリにアクセスし、外部ソースからデータを取得するために使用できます。

import { getSearchResults } from '@/lib/search'
 
export default async function SearchPage({
  searchParams,
}: {
  searchParams: { [key: string]: string | string[] | undefined }
}) {
  const results = await getSearchResults(searchParams.query)
 
  return <div>...</div>
}

<Form>がユーザーのビューポートに表示されると、/searchページの共有UI（layout.jsやloading.jsなど）がプリフェッチされます。送信されると、フォームはすぐに新しいルートに移動し、結果の取得中はローディングUIを表示します。フォールバックUIはloading.jsを使用して設計できます。

export default function Loading() {
  return <div>Loading...</div>
}

共有UIがまだ読み込まれていない場合に備えて、useFormStatusを使用してユーザーにすぐにフィードバックを表示できます。

まず、フォームが保留中の場合にローディング状態を表示するコンポーネントを作成します。

'use client'
import { useFormStatus } from 'react-dom'
 
export default function SearchButton() {
  const status = useFormStatus()
  return (
    <button type="submit">{status.pending ? 'Searching...' : 'Search'}</button>
  )
}

次に、SearchButtonコンポーネントを使用するように検索フォームページを更新します。

import Form from 'next/form'
import { SearchButton } from '@/ui/search-button'
 
export default function Page() {
  return (
    <Form action="/search">
      <input name="query" />
      <SearchButton />
    </Form>
  )
}

サーバーアクションを使用したミューテーション

actionプロパティに関数を渡すことで、ミューテーションを実行できます。

import Form from 'next/form'
import { createPost } from '@/posts/actions'
 
export default function Page() {
  return (
    <Form action={createPost}>
      <input name="title" />
      {/* ... */}
      <button type="submit">Create Post</button>
    </Form>
  )
}

ミューテーション後、新しいリソースにリダイレクトするのが一般的です。next/navigationのredirect関数を使用して、新しい投稿ページに移動できます。

補足事項: フォーム送信先の「宛先」はアクションが実行されるまでわからないため、<Form>は共有UIを自動的にプリフェッチできません。

'use server'
import { redirect } from 'next/navigation'
 
export async function createPost(formData: FormData) {
  // Create a new post
  // ...
 
  // Redirect to the new post
  redirect(`/posts/${data.id}`)
}

次に、新しいページで、paramsプロパティを使用してデータを取得できます。

import { getPost } from '@/posts/data'
 
export default async function PostPage({ params }: { params: { id: string } }) {
  const data = await getPost(params.id)
 
  return (
    <div>
      <h1>{data.title}</h1>
      {/* ... */}
    </div>
  )
}

詳細はサーバーアクションのドキュメントを参照してください。