npm:react-mute | Skypack

README

Mute the bad words in react component

Introduction

Stop people from polluting your react application with bad words. Mute the bad words.

This library uses react fragment and thus does not add any DOM node.

Installing

  $ yarn add react-mute

Usage

  import Mute from 'react-mute';

  // in render
  <Mute
    safeText="❤️"
    addWords=["bad"]
  >{"Actual text there bad words are to be muted"}
  </Mute>

  // => Actual text there ❤️❤️❤️ words are to be muted

API

`children`

type: string

Text that needs to be muted

`addWords`

type: Array

Array of words to mute. These will append to the list of existing list of bad words.

List of words → https://github.com/web-mech/badwords/blob/master/lib/lang.json

`removeWords`

type: Array

Array of words to unmute. This will remove words from existing list of bad words.

`safeText`

default: ''*

type: string

Replace these character in muted words.

*** This package is dependent on https://github.com/web-mech/badwords for badwords implementation ***

react-mute

Usage no npm install needed!