CensorItOverlayBuilder class final

Creates a widget that applies visual overlays over profanity.

Example:

CensorItWidget.overlayBuilder(
  'Fuck this!',
  builder: (context, word, revealed) => Container(
    color: Colors.black.withOpacity(0.8),
  ),
  pattern: LanguagePattern.english,
)
Inheritance

Constructors

CensorItOverlayBuilder(String text, {required CensorOverlayBuilder builder, CensorPattern? pattern, TextStyle? style, TextStyle? censoredStyle, bool onTap(bool isRevealed)?, Key? key})
Creates a widget that applies visual overlays over profanity.
const

Properties

builder → CensorOverlayBuilder
The function that generates overlay widgets.
final
censoredStyle → TextStyle?
Text style for censored (profane) words.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onTap → bool Function(bool isRevealed)?
Callback for handling tap events on censored words.
final
pattern → CensorPattern?
The language pattern for profanity detection.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
style → TextStyle?
Text style for normal (non-profane) text.
finalinherited
text → String
The text to be censored.
finalinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<CensorItOverlayBuilder>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited