SpellCheckConfiguration class

Controls how spell check is performed for text input.

This configuration determines the SpellCheckService used to fetch the List<SuggestionSpan> spell check results and the TextStyle used to mark misspelled words within text input.

Annotations

Constructors

SpellCheckConfiguration({SpellCheckService? spellCheckService, Color? misspelledSelectionColor, TextStyle? misspelledTextStyle, EditableTextContextMenuBuilder? spellCheckSuggestionsToolbarBuilder})
Creates a configuration that specifies the service and suggestions handler for spell check.
const
SpellCheckConfiguration.disabled()
Creates a configuration that disables spell check.
const

Properties

hashCode int
The hash code for this object.
no setteroverride
misspelledSelectionColor Color?
The color the paint the selection highlight when spell check is showing suggestions for a misspelled word.
final
misspelledTextStyle TextStyle?
Style used to indicate misspelled words.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
spellCheckEnabled bool
Whether or not the configuration should enable or disable spell check.
no setter
spellCheckService SpellCheckService?
The service used to fetch spell check results for text input.
final
spellCheckSuggestionsToolbarBuilder EditableTextContextMenuBuilder?
Builds the toolbar used to display spell check suggestions for misspelled words.
final

Methods

copyWith({SpellCheckService? spellCheckService, Color? misspelledSelectionColor, TextStyle? misspelledTextStyle, EditableTextContextMenuBuilder? spellCheckSuggestionsToolbarBuilder}) SpellCheckConfiguration
Returns a copy of the current SpellCheckConfiguration instance with specified overrides.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
override