本文へ移動
← Archive No.06 / 15 Astro →
Astro

Reactアイランドをやめて、素のJavaScriptでお問い合わせフォームを作る(Astro + reCAPTCHA v3)

Astro

「Astro Base」のお問い合わせフォームは、以前は React アイランド+ react-hook-form で作っていました。トップページのデザインを作り直したのをきっかけに、素の JavaScript に書き換え、React は依存ごと外しました。この記事では、その理由と今の実装を紹介します。

リポジトリ:Astro-MicroCMS-Site / デモ:https://astrobase.vercel.app/

React をやめた理由

  • フォームが小さい:項目は Name・Email・Message の 3 つで、チェックは必須とメール形式だけ。素の JS でも 20 行ほどで書けます。
  • JavaScript が減る:react-hook-form を使うには React と ReactDOM も読み込む必要があり、gzip 後でも 40KB を超えます。今は、トップページの動きを担当している home.js に数十行足しただけです。
  • 依存が減る:react / react-dom / @astrojs/react / react-hook-form と型定義をまとめて外せました。Astro をバージョンアップするときに一緒に上げるものが減り、保守が楽になります。

項目が多い、条件によって入力欄が変わる、サイト全体が React で作られている、といった場合は react-hook-form のほうが向いています。今回はどれにも当てはまらなかったので、素の JS を選びました。

マークアップ

フォームは index.astro に直接書きます。ブラウザ標準のエラー表示は使わず自前で出すので、novalidate を付けています。

astro
<!-- src/pages/index.astro -->
<form class="form-box" id="contactForm" novalidate>
  <div class="field">
    <input id="email" name="email" type="email" placeholder=" " autocomplete="email"
      aria-describedby="error-email-required">
    <label for="email">Email</label>
    <span class="err" id="error-email-required" aria-live="assertive"></span>
  </div>
  <!-- name / message も同じ形 -->
  <div class="form-foot">
    <button type="submit" class="submit">Submit</button>
    <span class="form-status" id="formStatus" aria-live="polite"></span>
  </div>
</form>

エラー表示の要素には aria-live を付け、入力欄とは aria-describedby でつなげて、スクリーンリーダーでもエラーが読み上げられるようにしています。この部分は React 版と同じです。

placeholder=" "(半角スペース)は、ラベルを浮かせる演出のためです。CSS の :placeholder-shown で「未入力かどうか」を判定し、入力があればラベルを上に移動させています。

スクリプトの置き場所

フォームの処理は src/scripts/home.js に書き、レイアウトの <script> から読み込みます。is:inline を付けない <script> は Astro(Vite)がまとめてバンドルするので、import が使え、ページをまたいでも 1 回しか読み込まれません。

astro
<!-- src/layouts/LayoutHome.astro -->
<ClientRouter />
...
<script>
  import "../scripts/layout.js";
  import "../scripts/article.js";
  import "../scripts/home.js";
</script>

このサイトは <ClientRouter /> でページ遷移をアニメーションさせているので、ページを移動してもスクリプトは最初に 1 回しか実行されません。そこで、astro:page-load イベントのたびに初期化し直す小さな関数 onPage() を用意しました。登録したイベントは、次のページに切り替わる直前に AbortController でまとめて外します。

js
// src/scripts/lifecycle.js
export function onPage(setup) {
  let cleanup = null;
  document.addEventListener('astro:page-load', async () => {
    const ac = new AbortController();
    cleanup = () => ac.abort();
    await setup({ signal: ac.signal });
  });
  document.addEventListener('astro:before-swap', () => {
    if (cleanup) cleanup();
    cleanup = null;
  });
}

home.js はどのページでも読み込まれるので、トップページかどうかを最初に確かめてから、フォームを準備します。

js
// src/scripts/home.js
onPage(async ({ signal }) => {
  if (!$('.hero')) return; // トップページ以外では何もしない
  setupContactForm(signal);
  // ...アニメーションなど
});

入力チェック

項目ごとのルールを、「エラーメッセージを返す関数」としてまとめます。問題なければ空文字を返します。

js
// src/scripts/home.js
function setupContactForm(signal) {
  const form = $('#contactForm'), status = $('#formStatus');
  const rules = {
    name: v => v ? '' : 'Name is required',
    email: v => !v ? 'Email is required'
      : (/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(v) ? '' : 'Please enter a valid email'),
    message: v => v ? '' : 'Message is required',
  };
  const names = Object.keys(rules);

  const check = n => {
    const el = form.elements[n], msg = rules[n](el.value.trim());
    el.closest('.field').classList.toggle('invalid', !!msg);
    el.setAttribute('aria-invalid', String(!!msg));
    $('#error-' + n + '-required').textContent = msg;
    return !msg;
  };
  // ...
}

いつチェックするかは、react-hook-form の mode: 'onChange' に近い動きにしました。

  • 入力欄からフォーカスが外れたとき(blur)にチェックする
  • いったんエラーになった欄は、入力するたび(input)にチェックし直し、直った時点でエラーを消す
js
names.forEach(n => {
  const el = form.elements[n];
  el.addEventListener('blur', () => check(n), { signal });
  el.addEventListener('input', () => {
    if (el.closest('.field').classList.contains('invalid')) check(n);
  }, { signal });
});

どのイベントにも { signal } を渡しているので、別のページに移動すると自動で外れます。トップページに戻ってきたときに、同じイベントが二重に登録されることもありません。

まだ何も入力していないうちからエラーが出ることはなく、直したらすぐ消えるので、入力する人を急かさずに済みます。

reCAPTCHA のサイトキーは astro:env で渡す

サイトキーは、astro.config.mjs で「ブラウザから読んでよい公開の変数」として宣言します。

js
// astro.config.mjs
env: {
  schema: {
    PUBLIC_RECAPTCHA_SITE_KEY: envField.string({
      context: 'client', access: 'public', optional: true, default: '',
    }),
  },
},

宣言した変数は、home.js から astro:env/client を import するだけで読めます。以前のように define:vars で window に載せ替える必要はありません。

js
// src/scripts/home.js
import { PUBLIC_RECAPTCHA_SITE_KEY as RECAPTCHA_SITE_KEY } from 'astro:env/client';

reCAPTCHA は送信するときに読み込む

reCAPTCHA のスクリプトは重いので、ページを開いたときではなく、送信ボタンが押されたときに読み込みます。

js
const loadRecaptcha = () => new Promise((res, rej) => {
  if (window.grecaptcha) return res();
  const s = document.createElement('script');
  s.src = `https://www.google.com/recaptcha/api.js?render=${RECAPTCHA_SITE_KEY}&hl=en`;
  s.onload = () => res();
  s.onerror = () => rej(new Error('Failed to load reCAPTCHA'));
  document.head.appendChild(s);
});

const getToken = async () => {
  if (!RECAPTCHA_SITE_KEY) return undefined; // キー未設定ならトークンなしで送る
  await loadRecaptcha();
  await new Promise(r => grecaptcha.ready(r));
  return grecaptcha.execute(RECAPTCHA_SITE_KEY, { action: 'submit' });
};

送信

送信時には全項目をまとめてチェックし、エラーがあれば最初のエラー欄にフォーカスを移します。問題なければボタンを無効にして二重送信を防ぎ、/api/contact に JSON で送ります。

js
import { navigate } from 'astro:transitions/client';

form.addEventListener('submit', async e => {
  e.preventDefault();
  const ok = names.map(check);
  if (ok.includes(false)) {
    form.elements[names[ok.indexOf(false)]].focus();
    return;
  }
  $('.submit', form).disabled = true;
  status.textContent = 'Sending…';

  const data = Object.fromEntries(names.map(n => [n, form.elements[n].value.trim()]));
  try {
    const googleReCaptchaToken = await getToken();
    const res = await fetch('/api/contact', {
      method: 'POST',
      body: JSON.stringify({ ...data, googleReCaptchaToken }),
      headers: { 'Content-Type': 'application/json', Accept: 'application/json' },
    });
    navigate(res.ok ? '/thanks' : '/error');
  } catch {
    navigate('/error');
  }
}, { signal });

ok は、先に map で全項目をチェックしてから判定しています。こうすると、エラーのある欄が一度に全部表示されます。every を使うと最初のエラーでチェックが止まり、2 つ目以降のエラーが表示されません。

送信後の移動には、location.href ではなく astro:transitions/client の navigate() を使っています。ほかのリンクと同じようにページ遷移のアニメーションがかかり、サイト全体の動きがそろいます。

送信先の /api/contact は Vercel Functions です。サーバー側でも必須項目・メール形式・reCAPTCHA のスコアを確認してから、Nodemailer で Gmail に送ります。フロントのチェックは入力する人のためのもので、迷惑な送信を防ぐのはサーバー側の役割です。開発中にこの API を動かす方法は、別記事「astro devでVercel Functionsを動かす」で紹介しています。

まとめ

  • 項目が少ないフォームなら、React アイランドにしなくても素の JS で十分
  • ルールを「エラーメッセージを返す関数」にまとめると、チェック処理が短くなる
  • blur でチェックし、エラーが出た欄だけ input でチェックし直すと、入力する人を急かさない
  • aria-live と aria-describedby で、エラーを読み上げられるようにする
  • ClientRouter を使うなら、astro:page-load で初期化し、イベントは signal でまとめて外す
  • サイトキーは astro:env で宣言し、astro:env/client から読み込む
  • reCAPTCHA は送信時に読み込み、送信後は navigate() で移動する