Spell Check/com.darkrockstudios.texteditor.spellcheck

Package-level declarations

The spell-checking editor: SpellCheckingTextEditor, the SpellCheckState holder and its rememberSpellCheckState factory, and the SpellCheckMode (word vs. sentence) selector.

Types

sealed class SpellCheckItem

Represents a spell check item that can be either a word-level misspelling or a sentence-level correction.

enum SpellCheckMode : Enum<SpellCheckMode>

Determines which spell checking mode is active.

SpellCheckState

class SpellCheckState(val textState: TextEditorState, var spellChecker: EditorSpellChecker?, enableSpellChecking: Boolean = true, var spellCheckMode: SpellCheckMode = SpellCheckMode.Word)

State holder that coordinates spell checking over a TextEditorState.

Functions

rememberSpellCheckState

fun rememberSpellCheckState(spellChecker: EditorSpellChecker?, initialText: AnnotatedString? = null, enableSpellChecking: Boolean = true, spellCheckMode: SpellCheckMode = SpellCheckMode.Word): SpellCheckState

Remembers a SpellCheckState for the editor.

SpellCheckingTextEditor

fun SpellCheckingTextEditor(spellChecker: EditorSpellChecker? = null, state: SpellCheckState = rememberSpellCheckState(spellChecker), modifier: Modifier = Modifier, contentPadding: PaddingValues = DefaultContentPadding, enabled: Boolean = true, autoFocus: Boolean = false, style: TextEditorStyle = rememberTextEditorStyle(), contextMenuStrings: ContextMenuStrings = ContextMenuStrings.Default, onRichSpanClick: RichSpanClickListener? = null)

A drop-in text editor composable with integrated spell checking.