Skip to content

An Android library that allows blocking of profanity words from text

License

Notifications You must be signed in to change notification settings

phucynwa/AndroidProfanityFilter

Repository files navigation

AndroidProfanityFilter

Twitter URL

Add to project

Step 1. Add it in your root build.gradle at the end of repositories:

Groovy

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Kotlin (build.gradle.kts)

allprojects {
    repositories {
        ...
        maven("https://jitpack.io")
    }
}

Step 2. Add the dependency

Groovy

dependencies {
    implementation 'com.github.phucynwa:AndroidProfanityFilter:0.0.3'
}

Kotlin (build.gradle.kts)

dependencies {
    implementation("com.github.phucynwa:AndroidProfanityFilter:0.0.3")
}

Using

val dictionary = PlainDictionary(this, "bad_words_en_us.txt")
val profanityFilter = AndroidProfanityFilter(dictionary = dictionary)
val censoredText = profanityFilter.censor(originalText)

License

Copyright 2021 Phuc YNWA

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.