You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -10,49 +9,49 @@ This was built in order to allow users to "Opt-in" to profanity filtering, and o
10
9
***Obvious warning:****The `swearWord` lists as well as code examples contain material that many will find offensive. (But that's the point!)*
11
10
*note: localization support provided by shutterstock's [List of Dirty, Naughty, Obscene, and Otherwise Bad Words](https://github.com/shutterstock/List-of-Dirty-Naughty-Obscene-and-Otherwise-Bad-Words)*
12
11
13
-
###**Usage:**###
12
+
###Usage:###
14
13
15
14
---
16
15
17
-
Option 1:
16
+
**Option 1:**
18
17
19
18
// Filter the word "shit" every time it shows up inside the element "SomeElement"
20
19
$('#SomeElement').profanityFilter({
21
20
customSwears: ['shit']
22
21
});
23
22
24
-
Option 2:
23
+
**Option 2:**
25
24
26
25
// Filter an external array of words on the entire document
27
26
$(document).profanityFilter({
28
27
externalSwears: '/Path/To/Json/Swears/'
29
28
});
30
29
31
-
Option 3:
30
+
**Option 3:**
32
31
33
32
// Change the replacement character from an astrisk (*) to a pound sign (#)
34
33
$('#SomeElement').profanityFilter({
35
34
externalSwears: '/Path/To/Json/Swears/',
36
35
replaceWith: '#'
37
36
});
38
37
39
-
Option 4:
38
+
**Option 4:**
40
39
41
40
// Change the replacement from astrisks (*) to random words
42
41
$('#SomeElement').profanityFilter({
43
42
externalSwears: '/Path/To/Json/Swears/',
44
43
replaceWith: ['fiddle', 'fun', 'stupendous']
45
44
});
46
45
47
-
Option 5:
46
+
**Option 5:**
48
47
49
48
// Combine an externl Swear list with a custom list (don't worry, we'll remove duplicates)
50
49
$('#SomeElement').profanityFilter({
51
50
customSwears: ['monkeyass'],
52
51
externalSwears: '/Path/To/Json/Swears/'
53
52
});
54
53
55
-
Option 6:
54
+
**Option 6:**
56
55
57
56
// Don't filter anything. Useful in conjunction with the profaneText callback (which only
58
57
// fires when profanity exists).
@@ -67,27 +66,27 @@ Option 6:
67
66
});
68
67
69
68
70
-
###**Get It:**###
69
+
###Get It:###
71
70
72
71
- bower `> bower install jQuery.ProfanityFilter`
73
72
74
-
###**Bug Tracker:**###
73
+
###Bug Tracker:###
75
74
76
75
---
77
76
78
77
Find a bug? Please create an issue here on GitHub!
0 commit comments