API Cookbook

This page collects small, copyable recipes for common integration tasks.

Load Text

controller.loadText(
    """
    fun main() {
        println("Hello")
    }
    """.trimIndent()
)

Load File

controller.loadFile("/absolute/path/to/file.kt")

Apply Theme And Settings

val appearance = rememberEditorAppearance(darkMode = true)

LaunchedEffect(controller, appearance) {
    controller.applyTheme(appearance.theme)
    controller.applySettings(EditorSettings())
}

Set Language Configuration

controller.setLanguageConfiguration(configuration)

Attach Editor Metadata

controller.setMetadata(
    EditorMetadata(
        entries = mapOf(
            "fileName" to "Main.kt",
            "language" to "kotlin",
        )
    )
)

Register A Decoration Provider

controller.addDecorationProvider(myDecorationProvider)

Register A Completion Provider

controller.addCompletionProvider(myCompletionProvider)

Provide Gutter Icons

controller.setEditorIconProvider(myIconProvider)

Show Inline Suggestion

controller.inlineSuggestions().show(
    InlineSuggestion(
        line = 4,
        column = 12,
        text = "println(value)",
    )
)

Trigger Completion Manually

controller.triggerCompletion()

Dismiss Completion

controller.dismissCompletion()

Observe Editor Events

val subscription = controller.events().subscribe<TextChangedEvent> { event ->
    println(event.editResult)
}

Remember to dispose subscriptions when you no longer need them.