bad_words_moderator 0.2.0

Flutter widget and functions to filter bad words from input text.

BadWordsModerator

BadWordsModerator is a Flutter widget that helps monitor and detect offensive words in user input fields. It automatically tracks all EditableText widgets (like TextField and TextFormField) within its child widget tree and triggers a callback whenever inappropriate words are detected.

Features

• Monitors all EditableText widgets in the subtree.
• Detects bad words in real-time with debounce control.
• Customizable bad word detection logic.
• Callback when bad words are found.

Installation

Add the dependency to your pubspec.yaml:

dependencies:
  bad_words_moderator:
    git:
      url: https://github.com/your-username/bad_words_moderator.git

Replace with your actual Git URL.

Usage

Wrap any part of your widget tree with BadWordsModerator:

import 'package:flutter/material.dart';
import 'package:bad_words_moderator/bad_words_moderator.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: BadWordsModerator(
          onDetected: (text) async {
            print("Bad words detected: $text");
          },
          child: Padding(
            padding: const EdgeInsets.all(16.0),
            child: TextField(),
          ),
        ),
      ),
    );
  }
}

Parameters

Parameter	Type	Description
child	Widget	The widget subtree that should be monitored.
onDetected	Future<void> Function(String text)	Callback triggered when bad words are detected.
detector	Future<bool> Function(String, String?)	Optional. Custom function to detect bad words (defaults to badWordsDetector).
debounce	Duration	Optional. Time interval to debounce input changes (default: 300ms).

Custom Detector

You can provide your own detector function:

Future<bool> myCustomDetector(String text, String? file) async {
  return text.contains("badword");
}

Then pass it to the widget:

BadWordsModerator(
  detector: myCustomDetector,
  onDetected: (text) async {
    // Handle detected bad word
  },
  child: MyWidgetTree(),
);

Notes

• Internally, it uses a post-frame callback to traverse and monitor all EditableText widgets.
• Supports dynamic updates to inputs via didChangeDependencies.

📄 License

MIT License. See LICENSE for details.