autocomplete/com.monkopedia.kodemirror.autocomplete

Package-level declarations

Types

data class ActiveSnippet(val fields: List<SnippetField>, val fieldIndex: Int)

Tracks the currently active snippet insertion — the list of tab-stop fields and the index of the field the cursor is at.

CloseBracketsConfig

data class CloseBracketsConfig(val brackets: String = "()[]{}''", val before: String = ")]}:;>")

Configuration for close-brackets behavior.

Completion

data class Completion(val label: String, val displayLabel: String? = null, val detail: String? = null, val info: String? = null, val type: String? = null, val boost: Int = 0, val apply: String? = null, val applyFn: (CompletionApplyContext) -> Unit? = null, val section: CompletionSection? = null)

A single completion option.

CompletionApplyContext

data class CompletionApplyContext(val session: EditorSession, val completion: Completion, val from: DocPos, val to: DocPos)

Context passed to Completion.applyFn when a completion is accepted.

CompletionConfig

data class CompletionConfig(val activateOnTyping: Boolean = true, val selectOnOpen: Boolean = true, val closeOnBlur: Boolean = true, val maxRenderedOptions: Int = 100, val icons: Boolean = true, val defaultKeymap: Boolean = true, val override: List<CompletionSource>? = null)

Configuration for the autocompletion extension.

CompletionContext

class CompletionContext(val state: EditorState, val pos: DocPos, val explicit: Boolean)

Context passed to completion sources.

CompletionResult

data class CompletionResult(val from: DocPos, val to: DocPos? = null, val options: List<Completion>, val validFor: Regex? = null, val filter: Boolean = true)

The result of a completion source query.

CompletionSection

data class CompletionSection(val name: String, val rank: Int = 0)

A named section for grouping completions.

CompletionSource

typealias CompletionSource = (CompletionContext) -> CompletionResult?

A function that provides completions for a given context.

CompletionType

enum CompletionType : Enum<CompletionType>

Standard completion type indicators. Use value as the Completion.type string, or pass the enum directly to Completion via CompletionType.value.

MatchBeforeResult

data class MatchBeforeResult(val from: DocPos, val to: DocPos, val text: String)

Result of CompletionContext.matchBefore.

SnippetField

data class SnippetField(val name: String, val from: DocPos, val to: DocPos)

A named field within an active snippet, spanning from to to in the document.

SuspendCompletionSource

typealias SuspendCompletionSource = suspend (CompletionContext) -> CompletionResult?

A suspend function that provides completions for a given context.

Properties

acceptCompletion

val acceptCompletion: (EditorSession) -> Boolean

Accept the currently selected completion.

clearSnippet

val clearSnippet: (EditorSession) -> Boolean

Clear the active snippet.

closeBracketsKeymap

val closeBracketsKeymap: List<KeyBinding>

Keymap for close-brackets: Backspace deletes bracket pair.

closeCompletion

val closeCompletion: (EditorSession) -> Boolean

Close the completion list.

completeAnyWord

val completeAnyWord: CompletionSource

A completion source that provides all words in the document.

completionBackground

val completionBackground: ThemeKey<Color>

Background color for the completion popup.

completionConfig

val completionConfig: Facet<CompletionConfig, CompletionConfig>

Facet for completion configuration.

completionDetailColor

val completionDetailColor: ThemeKey<Color>

Text color for completion detail/info text.

completionIconColor

val completionIconColor: ThemeKey<Color>

Text color for completion type icons.

completionKeymap

val completionKeymap: List<KeyBinding>

Default autocompletion keymap bindings.

completionSelectedBackground

val completionSelectedBackground: ThemeKey<Color>

Background color for the selected completion item.

completionTextColor

val completionTextColor: ThemeKey<Color>

Text color for completion labels.

deleteBracketPair

val deleteBracketPair: (EditorSession) -> Boolean

Delete bracket pair command: when cursor is between a pair, delete both.

nextSnippetField

val nextSnippetField: (EditorSession) -> Boolean

Move to the next snippet field, or clear the snippet if at the last field.

pickedCompletion

val pickedCompletion: AnnotationType<Completion>

Transaction annotation that tags a transaction where a completion was accepted. Extensions can read this to react to completion events.

prevSnippetField

val prevSnippetField: (EditorSession) -> Boolean

Move to the previous snippet field.

setSelectedCompletion

val setSelectedCompletion: StateEffectType<Int>

Effect to set the selected completion index.

snippetFieldActiveBackground

val snippetFieldActiveBackground: ThemeKey<Color>

Background color for the active snippet field.

snippetFieldBackground

val snippetFieldBackground: ThemeKey<Color>

Background color for inactive snippet fields.

snippetKeymap

val snippetKeymap: List<KeyBinding>

Default keymap for snippet field navigation: Tab, Shift-Tab, and Escape.

snippetState

val snippetState: StateField<ActiveSnippet?>

State field that holds the currently active snippet, or null when no snippet is active.

startCompletion

val startCompletion: (EditorSession) -> Boolean

Explicitly start completion (Ctrl-Space).

Functions

asyncCompletionSource

expect fun asyncCompletionSource(source: SuspendCompletionSource): CompletionSource

Wrap a SuspendCompletionSource into a CompletionSource that runs the suspend function in a blocking context.

actual fun asyncCompletionSource(source: SuspendCompletionSource): CompletionSource

Wrap a SuspendCompletionSource into a CompletionSource that runs the suspend function in a blocking context.

actual fun asyncCompletionSource(source: SuspendCompletionSource): CompletionSource

Wrap a SuspendCompletionSource into a CompletionSource that runs the suspend function in a blocking context.

actual fun asyncCompletionSource(source: SuspendCompletionSource): CompletionSource

Wrap a SuspendCompletionSource into a CompletionSource that runs the suspend function in a blocking context.

autocompletion

fun autocompletion(config: CompletionConfig = CompletionConfig()): Extension

Create the autocompletion extension.

closeBrackets

fun closeBrackets(config: CloseBracketsConfig = CloseBracketsConfig()): Extension

Extension that auto-closes brackets and quotes.

completeFromList

fun completeFromList(list: List<Completion>): CompletionSource

Create a completion source from a static list.

completionStatus

fun completionStatus(state: EditorState): String?

Get the completion status: "active" if completions are shown, null otherwise.

currentCompletions

fun currentCompletions(state: EditorState): List<Completion>

Get the current list of filtered completions.

hasNextSnippetField

fun hasNextSnippetField(state: EditorState): Boolean

Whether there is a next snippet field to navigate to.

hasPrevSnippetField

fun hasPrevSnippetField(state: EditorState): Boolean

Whether there is a previous snippet field to navigate to.

ifIn

fun ifIn(types: List<String>, source: CompletionSource): CompletionSource

Wrap a CompletionSource so it only activates when the cursor is inside one of the given syntax node types.

ifNotIn

fun ifNotIn(types: List<String>, source: CompletionSource): CompletionSource

Wrap a CompletionSource so it only activates when the cursor is NOT inside one of the given syntax node types.

insertBracket

fun insertBracket(state: EditorState, bracket: String): TransactionSpec

Programmatic bracket insertion.

insertCompletionText

fun insertCompletionText(state: EditorState, text: String, from: DocPos, to: DocPos): TransactionSpec

Insert completion text into the document (utility for custom apply functions).

moveCompletionSelection

fun moveCompletionSelection(forward: Boolean, by: String = "option"): (EditorSession) -> Boolean

Move the completion selection.

selectedCompletion

fun selectedCompletion(state: EditorState): Completion?

Get the currently selected completion.

selectedCompletionIndex

fun selectedCompletionIndex(state: EditorState): Int

Get the index of the currently selected completion.

snippet

fun snippet(template: String): (CompletionApplyContext) -> Unit

Parse a snippet template and return a function that, when called, applies the snippet at the given range in the editor.

snippetCompletion

fun snippetCompletion(template: String, completion: Completion): Completion

Create a Completion that, when accepted, inserts a snippet.

snippets

fun snippets(): Extension

Returns an extension that enables snippet support: the snippet state field, decoration highlights for active fields, and the Tab/Shift-Tab/Escape keymap for navigating between fields.