NewtとNext.jsを利用して、問い合わせフォームを作成する

このチュートリアルでは、Newtの Form App と Next.js を利用して、問い合わせフォームを作成する手順を紹介します。

記事内で使用している主なソフトウェアのバージョン

  • Next.js（next）: 13.1.2
  • React Hook Form（react-hook-form）: 7.43.0
  • React Google Recaptcha V3（react-google-recaptcha-v3）: 1.10.1

前提条件

  • Next.jsのプロジェクトを作成済みであること

Next.jsのセットアップについて知りたい場合は、以下のドキュメントをご確認ください。

概要

Next.jsで問い合わせフォームを作成し、Newtで問い合わせデータを確認できるようにします。
はじめに、自動返信・受信通知のついたシンプルなフォームを作成し、その後でバリデーション・スパム対策・リダイレクトの処理を実装しながら、カスタマイズの方法を学習していきます。
※ ここではスタイルについては扱いません。スタイルについて確認したい方は、問い合わせ用のテンプレート newt-contact-starter-nextjs を用意しているので、そちらのコードをご確認ください。

1. Form Appを作成する

はじめに、NewtでForm Appを作成します。

1-1. Form Appの追加

「Appを追加」をクリックして「タイプを選択して追加」を選択します。
form-tutorial1.jpg

「Form App」を選択して「追加」をクリックします。
form-tutorial2.jpg

App名・App UID・Appアイコンを設定して「追加」をクリックします。
form-tutorial3.jpg

これで「Contact」という名前のForm Appが追加されました。
form-tutorial4.jpg

1-2. フォームの作成

次にフォームを作成します。「フォームを作成」ボタンをクリックし、名前を付けてフォームを作成します。
form-tutorial5.jpg

作成後に表示されるエンドポイントは、2-1で利用します。
form-tutorial6.jpg

2. Next.jsでシンプルな問い合わせフォームを作成する

続いて、Next.jsでシンプルな問い合わせフォームを作成しましょう。
ここでは /contact というパスにアクセスした時に、問い合わせフォームを表示するようにします。

2-1. HTMLフォームの追加

pages/contact.tsx を作成し、以下のように記述します。
form の action 属性に設定している https://xxxxxx.form.newt.so/v1/xxxxxx の値については、1-2で確認したエンドポイントの値に置き換えてください。

// pages/contact.tsx

import Head from 'next/head'

export default function Contact() {
  return (
    <>
      <Head>
        <title>Newt・Next.jsフォーム</title>
        <meta
          name="description"
          content="NewtとNext.jsを利用した問い合わせフォームです"
        />
      </Head>
      <div>
        <h1>Contact us</h1>
        <form action="https://xxxxxx.form.newt.so/v1/xxxxxx" method="post">
          <label htmlFor="name">Name</label>
          <input id="name" name="name" />
          <label htmlFor="email">Email</label>
          <input id="email" name="email" type="email" />
          <label htmlFor="message">Message</label>
          <textarea id="message" name="message"></textarea>
          <button type="submit">Submit</button>
        </form>
      </div>
    </>
  )
}

各属性について説明します。

label要素のhtmlFor属性と、input要素・textarea要素のid属性
label要素 の for 属性は、JSXでは htmlFor として記述します。input要素 や textarea要素 の id 属性と一致するように設定してください。
※ 詳細は、Reactの アクセシブルなフォーム のドキュメントをご確認ください。

input要素・textarea要素のname属性
input要素・textarea要素のnameで設定された値をもとに、投稿データのスキーマが決まります。例えば上記の例では、name・email・message フィールドを持ったスキーマが作成されます。
詳細については、フィールドの仕様 のドキュメントをご確認ください。

input要素のtype属性
お好みの入力形式に応じて、inputの型 を選択してください。デフォルトでは text となります。

これで http://localhost:3000/contact にアクセスすると、以下のような問い合わせフォームが作成できました。
※ スタイルについてはお好みで設定してください
nextjs-form1.png

2-2. 自動返信メールの設定

自動返信メール の設定をします。自動返信メールを設定することで、投稿を送信したエンドユーザーに対して、設定した内容のメールを自動で送信できます。

※ Newtは自動返信メールの送信先メールアドレスを検出するために email フィールドを使います。input要素のname属性に email を指定し、エンドユーザーのメールアドレスが入力されるようにしてください。

「App設定」から該当のフォームをクリックし、「メール設定」を選択します。
「自動返信メールを有効にする」にチェックを入れ、件名と本文を入力し、「保存」をクリックします。

form-tutorial7.jpg

自動返信メールでは {submission.name} のように記述することで、メールの件名や本文に、投稿データの内容を埋め込めます。
2-1で、input要素・textarea要素のname属性に name・email・message を指定したので、ここでは {submission.name}・{submission.email}・{submission.message} を利用できます。

2-3. 受信通知メールの設定

受信通知メール の設定をします。受信通知メールを設定することで、エンドユーザーから新しいメッセージを受信した際に、メールで通知を受け取れます。

「App設定」から該当のフォームをクリックし、「メール設定」を選択します。
「受信通知メールを有効にする」にチェックを入れ、通知を受け取るメールアドレス・件名・本文を設定し、「保存」をクリックします。

form-tutorial8.jpg

受信通知メールでも、自動返信メールと同様に、投稿データの内容を埋め込めます。

2-4. 挙動の確認

これで、シンプルな問い合わせフォームを作成できました。
実際に動かして、挙動を確認してみましょう。

まず、開発サーバーを立ち上げて、問い合わせフォームを表示します。ここでは http://localhost:3000/contact にアクセスします。
適当な内容を入力して送信すればよいですが、設定したEmail（name属性に email を指定した入力値）に自動返信メールが届くので、ご自身のメールアドレスを入力するよう気をつけてください。
nextjs-form2.png

送信が成功すると、以下の画面が表示されます。
form-tutorial9.png

管理画面では、以下のようにデータが確認できます。
form-tutorial10.jpg

次に自動返信メールを確認します。以下のようなメールが飛んでいれば成功です。
form-tutorial11.png

最後に受信通知メールを確認します。以下のようなメールが飛んでいれば成功です。
form-tutorial12.png

これでシンプルなフォームの作成・自動返信メールの設定・受信通知メールの設定ができました。ここからはフォームのカスタマイズをしながら、より高度なフォームの作成方法を学んでいきましょう。

3. バリデーションを追加する

クライアントサイドのバリデーションについて、以下の順で紹介します。

  • input要素の属性を利用したバリデーション
  • JavaScriptを利用したバリデーション（React Hook Formを利用したバリデーション）

3-1. input要素の属性を利用したバリデーション

HTML5のフォームバリデーションを利用することで、JavaScriptなしでバリデーションを実行できます。よく使われるものについては HTML5のフォームバリデーション をご確認ください。

例えば、name を必須にしたい場合は、以下のように required を指定します。

<input id="name" name="name" required />

もし name を指定せず、送信を実行した場合は、以下のように表示されます。
nextjs-form3.png

3-2. JavaScriptを利用したバリデーション

HTMLネイティブのフォームバリデーションでは足りない場合、JavaScriptを利用することで、より柔軟なバリデーションを実行できます。
ここでは、バリデーションのタイミングを変え、さらにエラーメッセージをカスタマイズしてみましょう。

JavaScriptを利用してフォームを送信する場合（Acceptヘッダーでapplication/jsonを指定してレスポンスをJSONデータとして受け取る場合）、ご自身で送信後の表示を制御していただくことになります。
デフォルトのThanksページ・Errorページへのリダイレクトや カスタムリダイレクト は行われなくなりますので、ご注意ください。

ここでは React Hook Form を利用してバリデーションを行います。まずは react-hook-form をインストールしましょう。

npm install react-hook-form
# or
yarn add react-hook-form

続いて、以下のように pages/contact.tsx を修正します。
※ fetch の リソースとして設定されている https://xxxxxx.form.newt.so/v1/xxxxxx の値については、1-2で確認したエンドポイントの値に置き換えてください。

// pages/contact.tsx

import Head from 'next/head'
import { useForm } from 'react-hook-form'

type FormValues = {
  name: string
  email: string
  message: string
}

export default function Contact() {
  const {
    register,
    handleSubmit,
    formState: { errors },
  } = useForm<FormValues>({ mode: 'onChange' })

  const onSubmit = handleSubmit(async (data) => {
    const formData = new FormData()
    Object.entries(data).forEach(([key, value]) => {
      formData.append(key, value)
    })

    await fetch('https://xxxxxx.form.newt.so/v1/xxxxxx', {
      method: 'POST',
      body: formData,
      headers: {
        Accept: 'application/json',
      },
    })
  })

  return (
    <>
      <Head>
        <title>Newt・Next.jsフォーム</title>
        <meta
          name="description"
          content="NewtとNext.jsを利用した問い合わせフォームです"
        />
      </Head>
      <div>
        <h1>Contact us</h1>
        <form onSubmit={onSubmit}>
          <label htmlFor="name">Name*</label>
          <input
            id="name"
            {...register('name', { required: 'Name is required' })}
            aria-describedby="error-name-required"
          />
          {errors?.name && (
            <span id="error-name-required" aria-live="assertive">
              {errors.name.message}
            </span>
          )}
          <label htmlFor="email">Email</label>
          <input id="email" {...register('email')} />
          <label htmlFor="message">Message</label>
          <textarea id="message" {...register('message')}></textarea>
          <button type="submit">Submit</button>
        </form>
      </div>
    </>
  )
}

以下のことを行っています。

  • 入力値の型として、FormValues を定義し、useForm にジェネリクスとして渡します
  • useForm に mode という引数を渡しています。これはどのタイミングでバリデーションを行うか制御しています。ここでは onChange を指定し、変更のたびにバリデーションを実行します
  • 入力されたフォームのデータは handleSubmit 関数で data として利用できます
  • FormData を利用して、送信するデータ formData を作成します
  • フェッチ API を利用して、1-2で確認したエンドポイントにデータを送ります。この時、Acceptヘッダーに 'application/json' を指定します

また、以下の部分で name がない場合に Name is required というエラーメッセージを出しています。
register メソッドを利用して、様々なバリデーションが設定できるので、ぜひお好きなバリデーションをお試しください。

<label htmlFor="name">Name*</label>
<input
  id="name"
  {...register('name', { required: 'Name is required' })}
  aria-describedby="error-name-required"
/>
{errors?.name && (
  <span id="error-name-required" aria-live="assertive">
    {errors.name.message}
  </span>
)}

以下のことを確認します。

  • 入力変更があったタイミングでバリデーションが実行されること
  • name が入力されていない場合に Name is required というエラーメッセージが出ること

nextjs-form4.png

4. スパム対策を実装する

続いて、スパム対策 として Google reCAPTCHA v3 の設置方法について説明します。

4-1. サイトキーとシークレットキーの取得

Google reCAPTHAのコンソール にアクセスし、新しいサイトを登録します。

reCAPTCHAタイプは reCAPTCHA v3 を選択します。
ここではローカル環境でのテストを行うので、ドメインには localhost を追加します。本番環境で設定したい場合は、reCAPTCHAを導入したいサイトのドメインを設定してください。
form-tutorial13.jpg

全ての項目を入力して「送信」をクリックすると、サイトキーとシークレットキーが表示されます。
form-tutorial14.jpg

4-2. シークレットキーの登録

Newtの管理画面にアクセスし、「App設定」を開きます。該当のフォームをクリックし、「フォーム設定」を選択します。
「スパム対策」のセクションより、「Google reCAPTCHA v3を有効にする」にチェックを入れ、4-1で取得したシークレットキーを貼り付けて保存します。
spam-filtering1.png

4-3. Next.jsでの設定

最後にNext.jsでの設定を行います。ここでは React Google Recaptcha V3 を用いて、設定します。まずはReact Google Recaptcha V3をインストールしましょう。

npm install react-google-recaptcha-v3
# or
yarn add react-google-recaptcha-v3

続いて、pages/_app.tsx のファイルで、Component を GoogleReCaptchaProvider でラップします。以下のように修正します。
reCaptchaKey に設定している reCAPTCHA_site_key のところは、4-1で取得したサイトキーを入力してください。
※ GoogleReCaptchaProvider に設定できるオプションの詳細は React Google Recaptcha V3 をご確認ください。

import '@/styles/globals.css'
import type { AppProps } from 'next/app'
+ import { GoogleReCaptchaProvider } from 'react-google-recaptcha-v3'

export default function App({ Component, pageProps }: AppProps) {
- return <Component {...pageProps} />
+ return (
+   <GoogleReCaptchaProvider reCaptchaKey="reCAPTCHA_site_key" language="ja">
+     <Component {...pageProps} />
+   </GoogleReCaptchaProvider>
+ )
}

ここでは language に ja を設定しているため、問い合わせフォームの右下に表示されるreCAPTCHAのバッジが日本語になります。他の言語で設定したい方は、Googleの Language Codes のドキュメントを参考に設定してください。
form-tutorial15.jpg

最後に送信データに googleReCaptchaToken を追加します。
3-2で作成した pages/contact.tsx に、以下を追加します。

import Head from 'next/head'
import { useForm } from 'react-hook-form'
+ import { useGoogleReCaptcha } from 'react-google-recaptcha-v3'

type FormValues = {
  name: string
  email: string
  message: string
+ googleReCaptchaToken: string
}

export default function Contact() {
  const {
    register,
    handleSubmit,
    formState: { errors },
  } = useForm<FormValues>({ mode: 'onChange' })
+ const { executeRecaptcha } = useGoogleReCaptcha()

  const onSubmit = handleSubmit(async (data) => {
+   if (!executeRecaptcha) return
+   const token = await executeRecaptcha('submit')
+   data.googleReCaptchaToken = token

    const formData = new FormData()
    Object.entries(data).forEach(([key, value]) => {
      formData.append(key, value)
    })

    await fetch('https://xxxxxx.form.newt.so/v1/xxxxxx', {
      method: 'POST',
      body: formData,
      headers: {
        Accept: 'application/json',
      },
    })
  })

  return (
    （省略）
  )
}

以下のことを行っています。

  • useGoogleReCaptcha をインポートします
  • executeRecaptcha のnullチェックをし、利用可能か確認します
  • googleReCaptchaToken というフィールド名でトークンを送信します

これでGoogle reCAPTCHA v3によるスパム対策が実装できました。

もし、バッジを非表示にしたい場合、Googleの reCAPTCHA バッジを非表示にします。どうすればよいですか？ のドキュメントをご確認ください。

5. リダイレクトをカスタマイズする

最後にフォーム送信後のリダイレクトをカスタマイズします。
送信が成功した場合のページと、失敗した場合のページを用意して、送信結果に応じてリダイレクトしてみましょう。

5-1. 送信成功ページ・送信失敗ページを用意する

送信成功ページとして、以下を用意します。
page/thanks.tsx を作成します。

// page/thanks.tsx

import Head from 'next/head'
import Link from 'next/link'

export default function Thanks() {
  return (
    <>
      <Head>
        <title>Thank you</title>
        <meta name="description" content="問い合わせの送信が成功しました" />
      </Head>
      <div>
        <h1>Thank you!</h1>
        <div>
          <Link href="/contact">Back to Previous Page</Link>
        </div>
      </div>
    </>
  )
}

送信失敗ページとして、以下を用意します。
page/error.tsx を作成します。

// page/error.tsx

import Head from 'next/head'
import Link from 'next/link'

export default function Error() {
  return (
    <>
      <Head>
        <title>Error</title>
        <meta name="description" content="問い合わせの送信が失敗しました" />
      </Head>
      <div>
        <h1>Error!</h1>
        <div>
          <Link href="/contact">Back to Previous Page</Link>
        </div>
      </div>
    </>
  )
}

5-2. リダイレクトを設定する

page/contact.tsx を以下のように修正します。
※ fetch の リソースとして設定されている https://xxxxxx.form.newt.so/v1/xxxxxx の値については、1-2で確認したエンドポイントの値に置き換えてください。

import Head from 'next/head'
import { useForm } from 'react-hook-form'
import { useGoogleReCaptcha } from 'react-google-recaptcha-v3'
+ import { useRouter } from 'next/router'

type FormValues = {
  name: string
  email: string
  message: string
  googleReCaptchaToken: string
}

export default function Contact() {
+ const router = useRouter()
  const {
    register,
    handleSubmit,
    formState: { errors },
  } = useForm<FormValues>({ mode: 'onChange' })
  const { executeRecaptcha } = useGoogleReCaptcha()

  const onSubmit = handleSubmit(async (data) => {
    if (!executeRecaptcha) return
    const token = await executeRecaptcha('submit')
    data.googleReCaptchaToken = token

    const formData = new FormData()
    Object.entries(data).forEach(([key, value]) => {
      formData.append(key, value)
    })

-   await fetch('https://xxxxxx.form.newt.so/v1/xxxxxx', {
-     method: 'POST',
-     body: formData,
-     headers: {
-       Accept: 'application/json',
-     },
-   })
+   try {
+     const response = await fetch(
+       'https://xxxxxx.form.newt.so/v1/xxxxxx',
+       {
+         method: 'POST',
+         body: formData,
+         headers: {
+           Accept: 'application/json',
+         },
+       }
+     )
+
+     if (response.ok) {
+       router.push('/thanks')
+     } else {
+       router.push('/error')
+     }
+   } catch (err) {
+     router.push('/error')
+ }

  return (
    （省略）
  )
}

送信が成功した場合（response.ok がtrueの場合）は /thanks にリダイレクトし、送信成功ページを表示しています。
送信が失敗した場合（response.ok がfalseの場合、またはエラーが発生した場合）は /error にリダイレクトし、送信失敗ページを表示しています。

これでリダイレクトをカスタマイズすることができました。

以上で、すべてのステップが終了となります。

Form Appでは、他にもさまざまな機能があるので、興味のある方はぜひ以下のドキュメントもご覧ください。

Newt Made in Newt