Web3Forms React Plugin
We have an official Web3Forms React Plugin to help you send form submissions easily using Web3Forms & React, Next.js etc.
@web3forms/react is available to download from npm and the source on github.
The following example shows how you can create a working contact form using this react hook.
First, install the plugins from NPM:
npm install @web3forms/react
npm install react-hook-form
# or
pnpm add @web3forms/react
pnpm add react-hook-formThen, Import the Plugin & add the following code.
Basic Example
import { useState, useEffect } from "react";
// npm install react-hook-form @web3forms/react
import { useForm } from "react-hook-form";
import useWeb3Forms from "@web3forms/react";
export default function Contact() {
const {register, reset, handleSubmit} = useForm();
const [isSuccess, setIsSuccess] = useState(false);
const [result, setResult] = useState(null);
const accessKey = "YOUR_ACCESS_KEY_HERE";
const { submit: onSubmit } = useWeb3Forms({
access_key: accessKey,
settings: {
from_name: "Acme Inc",
subject: "New Contact Message from your Website",
// ... other settings
},
onSuccess: (msg, data) => {
setIsSuccess(true);
setResult(msg);
reset();
},
onError: (msg, data) => {
setIsSuccess(false);
setResult(msg);
},
});
return (
<div>
<form onSubmit={handleSubmit(onSubmit)}>
<input type="text" {...register("name", { required: true })}>
<input type="email" {...register("email", { required: true })}>
<textarea {...register("message", { required: true })}></textarea>
<button type="submit">Submit Form</button>
</form>
<div>{result}</div>
</div>
);
}Advanced Example (with tailwindcss)
contact.js
// This example uses `@web3forms/react` plugin and tailwindcss for css styling
import { useState, useEffect } from "react";
import { useForm } from "react-hook-form";
import useWeb3Forms from "@web3forms/react";
export default function Contact() {
const {
register,
handleSubmit,
reset,
watch,
control,
setValue,
formState: { errors, isSubmitSuccessful, isSubmitting },
} = useForm({
mode: "onTouched",
});
const [isSuccess, setIsSuccess] = useState(false);
const [message, setMessage] = useState(false);
// Please update the Access Key in the .env
const apiKey = process.env.PUBLIC_ACCESS_KEY || "YOUR_ACCESS_KEY_HERE";
const { submit: onSubmit } = useWeb3Forms({
access_key: apiKey,
settings: {
from_name: "Acme Inc",
subject: "New Contact Message from your Website",
},
onSuccess: (msg, data) => {
setIsSuccess(true);
setMessage(msg);
reset();
},
onError: (msg, data) => {
setIsSuccess(false);
setMessage(msg);
},
});
return (
<>
<form onSubmit={handleSubmit(onSubmit)} className="my-10">
<input
type="checkbox"
id=""
className="hidden"
style={{ display: "none" }}
{...register("botcheck")}></input>
<div className="mb-5">
<input
type="text"
placeholder="Full Name"
autoComplete="false"
className={`w-full px-4 py-3 border-2 placeholder:text-gray-800 dark:text-white rounded-md outline-none dark:placeholder:text-gray-200 dark:bg-gray-900 focus:ring-4 ${
errors.name
? "border-red-600 focus:border-red-600 ring-red-100 dark:ring-0"
: "border-gray-300 focus:border-gray-600 ring-gray-100 dark:border-gray-600 dark:focus:border-white dark:ring-0"
}`}
{...register("name", {
required: "Full name is required",
maxLength: 80,
})}
/>
{errors.name && (
<div className="mt-1 text-red-600">
<small>{errors.name.message}</small>
</div>
)}
</div>
<div className="mb-5">
<label htmlFor="email_address" className="sr-only">
Email Address
</label>
<input
id="email_address"
type="email"
placeholder="Email Address"
name="email"
autoComplete="false"
className={`w-full px-4 py-3 border-2 placeholder:text-gray-800 dark:text-white rounded-md outline-none dark:placeholder:text-gray-200 dark:bg-gray-900 focus:ring-4 ${
errors.email
? "border-red-600 focus:border-red-600 ring-red-100 dark:ring-0"
: "border-gray-300 focus:border-gray-600 ring-gray-100 dark:border-gray-600 dark:focus:border-white dark:ring-0"
}`}
{...register("email", {
required: "Enter your email",
pattern: {
value: /^\S+@\S+$/i,
message: "Please enter a valid email",
},
})}
/>
{errors.email && (
<div className="mt-1 text-red-600">
<small>{errors.email.message}</small>
</div>
)}
</div>
<div className="mb-3">
<textarea
name="message"
placeholder="Your Message"
className={`w-full px-4 py-3 border-2 placeholder:text-gray-800 dark:text-white dark:placeholder:text-gray-200 dark:bg-gray-900 rounded-md outline-none h-36 focus:ring-4 ${
errors.message
? "border-red-600 focus:border-red-600 ring-red-100 dark:ring-0"
: "border-gray-300 focus:border-gray-600 ring-gray-100 dark:border-gray-600 dark:focus:border-white dark:ring-0"
}`}
{...register("message", {
required: "Enter your Message",
})}
/>
{errors.message && (
<div className="mt-1 text-red-600">
{" "}
<small>{errors.message.message}</small>
</div>
)}
</div>
<button
type="submit"
className="w-full py-4 font-semibold text-white transition-colors bg-gray-900 rounded-md hover:bg-gray-800 focus:outline-none focus:ring-offset-2 focus:ring focus:ring-gray-200 px-7 dark:bg-white dark:text-black ">
{isSubmitting ? (
<svg
className="w-5 h-5 mx-auto text-white dark:text-black animate-spin"
xmlns="http://www.w3.org/2000/svg"
fill="none"
viewBox="0 0 24 24">
<circle
className="opacity-25"
cx="12"
cy="12"
r="10"
stroke="currentColor"
strokeWidth="4"></circle>
<path
className="opacity-75"
fill="currentColor"
d="M4 12a8 8 0 018-8V0C5.373 0 0 5.373 0 12h4zm2 5.291A7.962 7.962 0 014 12H0c0 3.042 1.135 5.824 3 7.938l3-2.647z"></path>
</svg>
) : (
"Send Message"
)}
</button>
</form>
{isSubmitSuccessful && isSuccess && (
<div className="mt-3 text-sm text-center text-green-500">
{message || "Success. Message sent successfully"}
</div>
)}
{isSubmitSuccessful && !isSuccess && (
<div className="mt-3 text-sm text-center text-red-500">
{message || "Something went wrong. Please try later."}
</div>
)}
</>
);
}
Last updated