Spell Check/com.darkrockstudios.texteditor.spellcheck.api/EditorSpellChecker

EditorSpellChecker

interface EditorSpellChecker(source)

A platform-agnostic spell checker interface used by the editor.

Inheritors

PlatformEditorSpellChecker

SymSpellEditorSpellChecker

Types

enum Scope : Enum<EditorSpellChecker.Scope>

Desired evaluation scope for suggestions.

Functions

open suspend fun checkSentence(sentence: String, sentenceRange: TextEditorRange): List<Correction>

Check a sentence for spelling errors that may span multiple words.

abstract suspend fun isCorrectWord(word: String): Boolean

Fast correctness check for a single lexical token (word).

abstract suspend fun suggestions(input: String, scope: EditorSpellChecker.Scope = Scope.Word, closestOnly: Boolean = true): List<Suggestion>

Suggestions for the given input. If scope == Word, input is a single token. If scope == Sentence, implementations may return suggestions that include whitespace (e.g., "in the"). Implementations that can't do sentence-level can ignore it or approximate.