API リファレンス / useFormMetadata

useFormMetadata

FormProvider に設定されたコンテキストを購読することで、フォームのメタデータを返す React フックです。

1const form = useFormMetadata(formId);

#パラメータ

formId

フォーム要素に設定される id 属性です。

#戻り値

form

フォームメタデータです。これは、 useForm フックによって返されるオブジェクトと同じです。

#Tips

FormId 型を用いたより良い型推論

フォームメタデータの型推論を改善するために、 string の代わりに FormId<Schema, FormError> 型を使用できます。

1import { type FormId, useFormMetadata } from '@conform-to/react';
2
3type ExampleComponentProps = {
4  formId: FormId<Schema, FormError>;
5};
6
7function ExampleComponent({ formId }: ExampleComponentProps) {
8  // これで `form.errors` と `form.getFieldset()` の結果の型を認識する。
9  const form = useFormMetadata(formId);
10
11  return <div>{/* ... */}</div>;
12}

コンポーネントをレンダリングする際には、 Conform によって提供されたフォーム ID を使用します。例えば、 form.idfields.fieldName.formId は、既に FormId<Schema, FormError> として型付けされています。これにより、 TypeScript は型が互換性があるかをチェックし、互換性がない場合に警告を出すことができます。 string を渡すこともできますが、型チェックの能力は失われます。

1import { useForm } from '@conform-to/react';
2
3function Example() {
4  const [form, fields] = useForm();
5
6  return (
7    <>
8      <ExampleComponent formId={form.id} />
9      <ExampleComponent formId={fields.fieldName.formId} />
10    </>
11  );
12}

しかし、 FormId 型をより具体的にするほど、コンポーネントの再利用が難しくなります。コンポーネントが SchemaFormError のジェネリクスを使用しない場合は、それを string としてシンプルに保つこともできます。

type ExampleComponentProps = {
  // スキーマやフォームエラーの型を気にしない場合
  formId: string;
  // フォームメタデータから特定のフィールドにアクセスしている場合
  formId: FormId<{ fieldName: string }>;
  // カスタムエラータイプを持っている場合
  formId: FormId<Record<string, any>, CustomFormError>;
};