mcpField
S
safe-action-forms

safe-action-forms

github.com/next-safe-actionDevelopment11.2k installsUpdated 8w ago
Repository

About safe-action-forms

A skill describing form integration patterns for next-safe-action, from native forms to React Hook Form adapters. It helps developers choose hooks based on form state, validation, and optimistic updates.

Key features

  1. 01Use native forms with useAction
  2. 02Track form state with useStateAction
  3. 03Connect React Hook Form adapters
  4. 04Support optimistic form updates
  5. 05Handle FormData and schema requirements

Use cases

  1. 01Build a simple action-backed form
  2. 02Show field-level validation errors
  3. 03Create forms with optimistic updates

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/next-safe-action/skills --skill safe-action-forms

After installing, type/safe-action-formsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

file-uploads.md
form-actions.md
react-hook-form.md

Details

From the project README

next-safe-action Form Integration

Options

ApproachWhen to Use
useAction + native formSimple forms, no complex validation UI, programmatic triggers
useStateAction + <form action={formAction}>Forms with state tracking, need prevResult access, full callbacks
useHookFormAction (RHF adapter)Complex forms with field-level errors, validation on change/blur
useHookFormOptimisticActionRHF forms with optimistic UI updates
useOptimisticStateActionInstant UI where overlapping writes must be queued and accumulate (see the hooks skill)

Quick Start — useStateAction Form

"use client";

import { useStateAction } from "next-safe-action/hooks";
import { submitContact } from "@/app/actions";

export function ContactForm() {
  const { formAction, result, isPending, hasSucceeded } = useStateAction(submitContact, {
    onSuccess: () => toast.success("Message sent!"),
  });

  return (
    <form action={formAction}>
      <input name="name" required />
      <input name="email" type="email" required />
      <textarea name="message" required />

      {result.validationErrors?.email && (
        <p>{result.validationErrors.email._errors?.[0]}</p>
      )}
      {result.serverError && <p>{result.serverError}</p>}
      {hasSucceeded && <p>Message sent!</p>}

      <button type="submit" disabled={isPending}>
        {isPending ? "Sending..." : "Send"}
      </button>
    </form>
  );
}

Note: useStateAction requires the server action to be defined with .stateAction() instead of .action(), and <form action={formAction}> passes raw FormData, so its input schema must parse FormData (e.g. zfd.formData({...}) from zod-form-data). See the hooks skill for the full decision table on when to use useAction vs useStateAction.

Quick Start — Native Form

"use client";

import { useAction } from "next-safe-action/hooks";
import { submitContact } from "@/app/actions";

export function ContactForm() {
  const { execute, result, isPending } = useAction(submitContact);

  return (
    <form
      onSubmit={(e) => {
        e.preventDefault();
        const fd = new FormData(e.currentTarget);
        execute({
          name: fd.get("name") as string,
          email: fd.get("email") as string,
          message: fd.get("message") as string,
        });
      }}
    >
      <input name="name" required />
      <input name="email" type="email" required />
      <textarea name="message" required />

      {result.validationErrors && (
        <p>{result.validationErrors.email?._errors?.[0]}</p>
      )}
      {result.serverError && <p>{result.serverError}</p>}
      {result.data && <p>Message sent!</p>}

      <button type="submit" disabled={isPending}>
        {isPending ? "Sending..." : "Send"}
      </button>
    </form>
  );
}

Quick Start — React Hook Form Adapter

"use client";

import { useHookFormAction } from "@next-safe-action/adapter-react-hook-form/hooks";
import { zodResolver } from "@hookform/resolvers/zod";
import { z } from "zod";
import { submitContact } from "@/app/actions";

const schema = z.object({
  name: z.string().min(1, "Name is required"),
  email: z.string().email("Invalid email"),
  message: z.string().min(10, "Message must be at least 10 characters"),
});

export function ContactForm() {
  const { form, handleSubmitWithAction, action } = useHookFormAction(
    submitContact,
    zodResolver(schema),
    {
      actionProps: {
        onSuccess: () => toast.success("Message sent!"),
      },
    }
  );

  return (
    <form onSubmit={handleSubmitWithAction}>
      <input {...form.register("name")} />
      {form.formState.errors.name && <p>{form.formState.errors.name.message}</p>}

      <input {...form.register("email")} />
      {form.formState.errors.email && <p>{form.formState.errors.email.message}</p>}

      <textarea {...form.register("message")} />
      {form.formState.errors.message && <p>{form.formState.errors.message.message}</p>}

      {action.result.serverError && <p>{action.result.serverError}</p>}

      <button type="submit" disabled={action.isPending}>
        {action.isPending ? "Sending..." : "Send"}
      </button>
    </form>
  );
}

Supporting Docs

Entry Points

PackageEntry PointExports
@next-safe-action/adapter-react-hook-formDefaultmapToHookFormErrors, types
@next-safe-action/adapter-react-hook-form/hooksHooksuseHookFormAction, useHookFormOptimisticAction, useHookFormActionErrorMapper

Comments

Markdown supported