richtext-editor/dev.mkeeda.arranger.richtext.editor/RichTextState

RichTextState

class RichTextState(initialText: <Error class: unknown class> = RichString(""), initialSelection: TextRange = TextRange(initialText.text.length))

A state object that can be hoisted to control and observe changes to RichTextEditor.

This state manages the underlying RichString, including the raw text and its associated formatting attributes (RichSpans). It acts as the single source of truth for the editor, integrating seamlessly with standard Compose text APIs.

Parameters

initialText

The initial RichString to display in the editor. Defaults to an empty RichString.

initialSelection

The initial TextRange selection or cursor position. Defaults to the end of initialText.

Constructors

RichTextState

constructor(initialText: <Error class: unknown class> = RichString(""), initialSelection: TextRange = TextRange(initialText.text.length))

Types

Companion

object Companion

Properties

currentAttributes

val currentAttributes: <Error class: unknown class>

The merged attributes at the current cursor position.

richString

val richString: <Error class: unknown class>

selection

val selection: TextRange

The current selection range within the text field. Returns TextRange.Zero when no selection is active (cursor at position 0).

typingAttributes

var typingAttributes: <Error class: unknown class>?

Attributes that will be applied to the next character typed via the keyboard.

undoState

val undoState: RichTextUndoState

Manages the undo and redo history for this state. Use this property to programmatically trigger undo/redo operations or observe their availability.

Functions

applyCompletion

fun RichTextState.applyCompletion(match: AutocompleteMatch, replacement: <Error class: unknown class>)

Replaces the range matched by match with the given RichString, preserving its styling attributes and positioning the cursor immediately after the replacement.

fun RichTextState.applyCompletion(match: AutocompleteMatch, replacement: String)

Replaces the range matched by match with the given replacement plain text, and positions the cursor immediately after the replacement.

fun RichTextState.applyCompletion(match: AutocompleteMatch, replacement: String, attributes: <Error class: unknown class>)

Replaces the range matched by match with the given replacement text, applies attributes using the specified attributes to the replacement, and positions the cursor immediately after it.

applyFormat

fun <T : Any> RichTextState.applyFormat(key: <Error class: unknown class><T>, value: T)

Applies the given value for a ParagraphAttributeKey.

fun <T : Any> RichTextState.applyFormat(key: <Error class: unknown class><T>, value: T)

Applies the given value for a SpanAttributeKey.

clearFormats

fun RichTextState.clearFormats()

Clears all currently active formats.

clearTypingAttributes

fun clearTypingAttributes()

Clears all typing attributes, reverting to the cursor's inherited attributes.

detectAndApplyLinks

fun RichTextState.detectAndApplyLinks()

Scans the current text for URLs and applies LinkKey attributes to them.

edit

fun edit(block: RichTextBuffer.() -> Unit)

Edits the underlying RichString state using a builder DSL. This allows you to apply or remove multiple attributes within a RichTextBuffer, as well as insert, delete, or replace text.

removeFormat

fun RichTextState.removeFormat(key: <Error class: unknown class><out <Error class: unknown class>>)

Removes the format associated with the given key.

removeTypingAttribute

fun <T> removeTypingAttribute(key: <Error class: unknown class><T>)

Removes a single attribute from the current typing attributes. Has no effect when a text range is selected (non-collapsed selection).

setRichString

fun setRichString(richString: <Error class: unknown class>)

Replaces the entire text and formatting attributes of this state with the given richString.

setTypingAttribute

fun <T> setTypingAttribute(key: <Error class: unknown class><T>, value: T)

Adds or overwrites a single attribute in the current typing attributes. Has no effect when a text range is selected (non-collapsed selection).

toggleFormat

fun RichTextState.toggleFormat(key: <Error class: unknown class><Unit>)

Toggles a ParagraphAttributeKey that does not require a value (i.e. its value is Unit).

fun RichTextState.toggleFormat(key: <Error class: unknown class><Unit>)

Toggles a SpanAttributeKey that does not require a value (i.e. its value is Unit).