CensorItWidgetBuilder class final

Creates a widget that replaces profanity with custom widgets.

Example:

CensorItWidget.widgetBuilder(
  'Fuck this!',
  builder: (context, word) => Icon(Icons.block),
  pattern: LanguagePattern.english,
)
Inheritance

Constructors

CensorItWidgetBuilder(String text, {required CensorWidgetBuilder builder, PlaceholderAlignment? alignment, TextBaseline? baseline, CensorPattern? pattern, TextStyle? style, TextStyle? censoredStyle, Key? key})
Creates a widget that replaces profanity with custom widgets.
const

Properties

alignment PlaceholderAlignment?
Where to vertically align the placeholder relative to the surrounding text.
final
baseline TextBaseline?
A horizontal line used for aligning text.
final
builder CensorWidgetBuilder
The function that generates replacement 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
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<CensorItWidgetBuilder>
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