Documentation

FormGrid

A responsive grid layout for arranging form fields.

Use grid layouts to align inputs for better scannability.

Preview

"use client";

import { zodResolver } from "@hookform/resolvers/zod";
import { useForm, FormProvider } from "react-hook-form";
import { z } from "zod";
import InputField from "@/components/ui/InputField";
import FormGrid from "@/components/ui/FormGrid";
import { schema } from "./form-grid-schema";

export function FormGridBasicExample() {
  const methods = useForm<z.infer<typeof schema>>({
    resolver: zodResolver(schema),
    defaultValues: {
      city: "",
      zip: "",
    },
  });

  const onSubmit = (data: z.infer<typeof schema>) => {
    console.log("Form data:", data);
    alert("Check the console for the form data!");
  };

  return (
    <FormProvider {...methods}>
      <form onSubmit={methods.handleSubmit(onSubmit)} className="space-y-4 w-[28rem]">
        <FormGrid>
          <InputField name="city" label="City" />
          <InputField name="zip" label="ZIP" />
        </FormGrid>
        <button
          type="submit"
          className="form-button form-button-primary w-full"
        >
          Submit
        </button>
      </form>
    </FormProvider>
  );
}

Props

NameTypeDefaultDescription
columnsnumber-Number of columns for the grid layout.
gapstring-Tailwind gap classes for spacing.