CensorIt #

Flutter library for censoring text based on predefined patterns and customizable characters.

Introduction #

When it comes to censoring text in your Flutter application, you might need to handle multiple languages and customize the characters used for censoring. CensorIt provides an easy-to-use solution for this problem.

Getting started #

In your pubspec.yaml file, add the following dependency:

dependencies:
  censor_it: ^1.0.0

Then, import the package in your Dart file:

import 'package:censor_it/censor_it.dart';

You can now use the CensorIt class to censor text:

void main() {
  // Create an instance of CensorIt with the text to be censored
  CensorIt censorIt = CensorIt("I don't give a fuck that there are a lot of obscene words here! I'm sure the developer of this lib is an asshole!", pattern: CensorPattern.english);

  // Get the censored text
  print(censorIt.toString());

  // Check if the text contains profanity
  print(censorIt.hasProfanity); // Output: true

  // Get a list of swear words found in the text
  print(censorIt.swearWords); // Output: [fuck, asshole]

  // Get a stream of censored text updated every second
  censorIt.stream(period: Duration(seconds: 1)).listen((censoredText) {
    print(censoredText);
  });
}

Features #

• Customizable Censor Patterns: Use predefined censor patterns for multiple languages or create your own.
• Customizable Censor Characters: Define your own set of characters to use for censoring.
• Stream Support: Get a stream of censored text updated at specified intervals.
• Profanity Detection: Check if the text contains any profanity based on the censor pattern.
• Swear Words Extraction: Extract a list of swear words found in the text.

Changelog #

Please see the Changelog page to know what's recently changed.

Contributions #

Feel free to contribute to this project.

If you find a bug or want a feature, but don't know how to fix/implement it, please fill an issue.
If you fixed a bug or implemented a feature, please send a pull request.