Skip to content

Latest commit

 

History

History
110 lines (73 loc) · 3.44 KB

README.md

File metadata and controls

110 lines (73 loc) · 3.44 KB
Raw

jQuery.profanityFilter plug-in

http://profanityFilter.chaseflorell.com

The jQuery.profanityFilter has the ability to filter out profane words on the client side.

This was built in order to allow users to "Opt-in" to profanity filtering, and offload all of the work to the client, saving the headache on the server. The jQuery.profanityFilter also attempts to use Local Storage on the client machine in order to reduce lookups at the externalSwears URL.

Obvious warning: The swearWord lists as well as code examples contain material that many will find offensive. (But that's the point!)
note: localization support provided by shutterstock's List of Dirty, Naughty, Obscene, and Otherwise Bad Words

###Usage:###

Option 1:

// Filter the word "shit" every time it shows up inside the element "SomeElement"
$('#SomeElement').profanityFilter({
	customSwears: ['shit']
});`

Option 2:

// Filter an external array of words on the entire document
$(document).profanityFilter({
	externalSwears: '/Path/To/Json/Swears/'
});

Option 3:

// Change the replacement character from an astrisk (*) to a pound sign (#)
$('#SomeElement').profanityFilter({
	externalSwears: '/Path/To/Json/Swears/',
	replaceWith: '#'
});

Option 4:

// Change the replacement from astrisks (*) to random words
$('#SomeElement').profanityFilter({
    externalSwears: '/Path/To/Json/Swears/',
    replaceWith: ['fiddle', 'fun', 'stupendous']
});

Option 5:

// Combine an externl Swear list with a custom list (don't worry, we'll remove duplicates)
$('#SomeElement').profanityFilter({
	customSwears: ['monkeyass'],
	externalSwears: '/Path/To/Json/Swears/'
});

###Bug Tracker:###

Find a bug? Please create an issue here on GitHub!
https://github.com/ChaseFlorell/jQuery.profanityFilter/issues

###Online Collaboration:###

Find out where we're at, and add your $0.02!
https://trello.com/b/OJfgkAvS

###Dependencies###

This plugin requires:

###Author:###

Chase Florell

###Copyright and License###

Copyright (c) 2012 Chase Florell

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.