view/com.monkopedia.kodemirror.view/EditorSession

EditorSession

interface EditorSession

An editor session holds the editor state and dispatches transactions.

Create instances via the EditorSession factory function or the rememberEditorSession composable.

Types

Companion

object Companion

Properties

coroutineScope

abstract val coroutineScope: CoroutineScope

CoroutineScope tied to the composition lifecycle.

editable

abstract val editable: Boolean

Whether the editor is in editable mode.

state

abstract val state: EditorState

The current editor state.

textDirection

abstract val textDirection: Direction

The overall text direction of the editor content.

Functions

bidiSpans

abstract fun bidiSpans(line: Line): List<BidiSpan>

Get the bidirectional text spans for a line.

coordsAtPos

abstract fun coordsAtPos(pos: Int, side: Int = 1): Rect?

Get the document coordinates of a position. Returns null when outside the viewport.

deleteRange

fun EditorSession.deleteRange(from: DocPos, to: DocPos)

Delete the text between from and to.

dispatch

abstract fun dispatch(vararg specs: TransactionSpec)

Dispatch one or more transaction specs against the current state.

dispatch

fun EditorSession.dispatch(block: TransactionSpecBuilder.() -> Unit)

Dispatch a transaction built via DSL.

dispatchTransaction

abstract fun dispatchTransaction(tr: Transaction)

Dispatch a fully-built transaction.

insertAt

fun EditorSession.insertAt(pos: DocPos, text: String)

Insert text at the given pos in the document.

phrase

abstract fun phrase(phrase: String, vararg insert: Any): String

Translate a phrase, optionally inserting values.

plugin

abstract fun <V : PluginValue> plugin(plugin: ViewPlugin<V>): V?

Get the current value of a view plugin, or null if the plugin is not active.

posAtCoords

abstract fun posAtCoords(x: Float, y: Float): Int?

Get the document position for on-screen coordinates. Returns null when outside the editor.

rememberFacet

@Composable

fun <T> EditorSession.rememberFacet(facet: Facet<*, T>): State<T>

Remember the current value of a Facet, recomposing only when its value changes.

rememberField

@Composable

fun <T> EditorSession.rememberField(field: StateField<T>): State<T>

Remember the current value of a StateField, recomposing only when its value changes.

select

fun EditorSession.select(anchor: DocPos, head: DocPos = anchor)

Set the selection to a range from anchor to head. If head is not provided, creates a cursor at anchor.

selectAll

fun EditorSession.selectAll()

Select the entire document.

setDoc

fun EditorSession.setDoc(text: String)

Replace the entire document content with text.

textDirectionAt

abstract fun textDirectionAt(pos: Int): Direction

Get the text direction at a specific position.