Recieve form submissions directly to your inbox without any configuration. Powered by Web3forms. Integrates with react-hook-form and other form libs too!
npm install use-web3formsRecieve form submissions directly to your inbox without any configuration. Powered by Web3forms. Integrates with react-hook-form and other form too!
!Downloads
!Size without zipping
!Size with zipping
!Zero dependencies
!License
!Types included
✅ Super lightweight
✅ Zero dependencies
✅ Full Typescript support
✅ Easy to use and a simple API
✅ Works with any form libraries
✅ Examples provided
✅ No configuration required (except for the API key)
✅ Works in Node.js (non-browser) environment too ✌️
https://use-web3forms.netlify.app/
☝️ useWeb3forms + React hook form. See the code here
``bash`
npm i use-web3forms
And for yarn users👇bash`
yarn add use-web3forms
Usage 📖
`js`
const { submit } = useWeb3forms({
apikey: "YOUR_ACCESS_KEY_HERE",
onSuccess: (successMessage, data) => {
console.log(successMessage, data)
},
onError: (errorMessage, data) => {
console.log(errorMessage, data)
},
});
then just provide the data to be submitted to function
`jsx {3-6}`
submit({
hello: "world",
isWorking: "Yesss!!!",
});
}}>
Submit form
---
`js
interface FormData {
hello: string;
isWorking: boolean | "Probably";
}
const { submit } = useWeb3forms
apikey: "YOUR_ACCESS_KEY_HERE",
onSuccess: (successMessage, data) => {
console.log(successMessage, data)
},
onError: (errorMessage, data) => {
console.log(errorMessage, data)
},
});
`
`jsx`
submit({
hello: "world",
isWorking: "Yesss!!!",
});
}}>
Submit form
> Make sure you provide a json with atleast one key-value pair to submit
For other examples please look into the examples directory. If you cannot find your favourite library/framework, just open a issue or just make a tiny contribution 😉
---
#### Should I have a Web3forms account to use this library?
You should get your API key from Web3forms which requires your email.
#### How many form submissions can I make?
Web3forms has a generous free plan. You can view the latest pricing here
Clone the project
`bash`
git clone https://github.com/Lalit2005/use-web3forms.git
Go to the project directory
`bash`
cd use-web3forms
Install dependencies
`bash`
yarn
Start the server
`bash`
yarn dev first builds the project so that the type definitions are emitted to dist and then microbundle` starts watching for file changes.