# clean-speech > Easily censor bad words Latest version **0.0.1** (published 2023-04-26) · MIT license · 0 weekly downloads ## Install ```sh npm install clean-speech pnpm add clean-speech yarn add clean-speech bun add clean-speech ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.0.1 | | Published | 2023-04-26 | | First published | 2023-04-26 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 6.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Erik Newland | | Maintainers | eriknewland | | Keywords | censor, input, textarea, profanity, filter, badwords, text, validation, toast, notification, language, sanitization | ## Links - npm: https://www.npmjs.com/package/clean-speech - npm.io page: https://npm.io/package/clean-speech ## Alternatives - [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads - [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads - [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads - [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads - [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads ## Recent versions - 0.0.1 (latest) — 2023-04-26 ## README # clean-speech: preemptively sanitize user text inputs A lightweight and customizable library to censor words in a textarea or input and display a toast message when a censored word is detected. ### Written in: ![TypeScript](https://img.shields.io/static/v1?style=for-the-badge&message=TypeScript&color=3178C6&logo=TypeScript&logoColor=FFFFFF&label=) ![clean-speech](https://user-images.githubusercontent.com/114263701/234681282-d1400675-7015-4e9f-b35f-fc5bb52fff8d.gif) This demo uses 'badword1', 'badword2', and 'badword3' user-typed bad words. ## Installation ```bash npm install clean-speech ``` ## Usage Import the `censorInput` function and call it with a configuration object: ```javascript import censorInput from 'clean-speech'; censorInput({ textareaSelector: '#text-area', censoredWords: ['badword1', 'badword2', 'badword3'], }); ``` ## Configuration Options The `censorInput` function accepts a configuration object with the following properties: | Property | Type | Required | Default | Description | |-------------------|------------------------------|----------|-------------------------------|-----------------------------------------------------------------------------| | textareaSelector | string | Yes | | A CSS selector for the textarea element to be censored. | | censoredWords | string[] | No | `[]` | An array of words to be censored. | | toastMessage | string | No | `'Please use nicer language!'`| The message to be displayed in the toast. | | toastStyle | Partial | No | Default styles | An object containing the CSS styles for the toast. | | toastDuration | number | No | `3000` | The duration for which the toast is displayed (in milliseconds). | | fadeDuration | number | No | `500` | The duration of the toast fade-out animation (in milliseconds). | ## Example `index.html`: ```html Text Area Example

Text Area Example

Enter some text: ``` `index.js`: ```javascript import censorInput from 'censor-input'; censorInput({ textareaSelector: '#text-area', censoredWords: ['badword1', 'badword2', 'badword3'], toastMessage: 'Please use nicer language!', toastStyle: { backgroundColor: 'rgba(255, 59, 48, 0.8)', }, toastDuration: 1000, fadeDuration: 200, }); ``` In this example, the `censorInput` function is called with a configuration object that specifies the textarea selector, censored words, toast message, custom toast background color, toast duration, and fade duration. --- _Source: https://npm.io/package/clean-speech · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._