profanity-validator
v1.3.6
Published
Profanity validation for React forms with react-hook-form & zod supported
Downloads
363
Maintainers
Readme
profanity-validator
A lightweight SDK for profanity filtering in forms. This library is designed to prevent bad word spam by validating user input and throwing errors if profanity is detected. Built to be flexible, it can be integrated easily into any HTML or JavaScript framework, including React, Next.js, and many more.
Features
- Profanity Filtering: Automatically detects and validates user input against a predefined list of profane words.
- Customizable: Allows users to add their own custom profanity words to the validation.
- Framework Agnostic: Works seamlessly across different frameworks and libraries.
- Error Handling: Throws validation errors instead of replacing profanity words, preventing form submission.
- Asynchronous Validation: Uses an internal API (profanity.dev) to check for profanity, Built by Josh .
Installation
You can install the SDK via any nodejs package manager:
npm install profanity-validator
pnpm add profanity-validator
bun add profanity-validator
yarn add profanity-validator
Contributing
We welcome contributions! Please feel free to submit a pull request or open an issue if you have suggestions or improvements.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Contact
For support or inquiries, please reach out to [email protected] or join our discord community!