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

Package-level declarations

Types

AttributeSerializer

class AttributeSerializer<T>(val key: <Error class: unknown class><T>, val saver: Saver<T, Any>)

Defines how to serialize and deserialize custom AttributeKey values for RichTextState.Saver.

AttributeStyleBuilder

class AttributeStyleBuilder

Builder for creating custom AttributeStyleResolver instances.

AttributeStyleResolver

fun interface AttributeStyleResolver

Resolves an AttributeContainer to Compose styles (SpanStyle and/or ParagraphStyle) for rendering rich text.

AutocompleteMatch

@Immutable

data class AutocompleteMatch(val trigger: AutocompleteTrigger, val query: String, val range: IntRange, val queryRange: IntRange, val cursorPosition: Int, val cursorRect: Rect? = null)

Represents an active autocompletion trigger match at the current cursor position.

AutocompleteTrigger

@Immutable

data class AutocompleteTrigger(val prefix: String, val id: String = prefix, val requireLeadingWhitespace: Boolean = true, val allowSpacesInQuery: Boolean = false, val maxQueryLength: Int = 50)

Defines a trigger pattern for autocompletion (e.g. '@' for mentions, '#' for tags, ':' for emojis).

ListMarkerResolver

fun interface ListMarkerResolver

Resolves a ListItem to a marker text string for display.

ResolvedRichStyle

data class ResolvedRichStyle(val spanStyle: SpanStyle? = null, val paragraphStyle: ParagraphStyle? = null)

A container representing the resolved visual styles for a set of attributes.

RichTextBuffer

class RichTextBuffer

A buffer for safely mutating both text and attributes of a RichTextState within an edit block. This class provides attribute operations by delegating to RichStringScope and adds text operations like insert, delete, and replace.

RichTextState

@Stable

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.

RichTextUndoState

@Stable

class RichTextUndoState

Manages the undo and redo history for a RichTextState.

SpanClickEvent

class SpanClickEvent(val span: <Error class: unknown class>)

Represents a click or tap event on a RichSpan within the rich text editor.

Properties

DefaultAttributeStyleResolver

val DefaultAttributeStyleResolver: AttributeStyleResolver

The standard default AttributeStyleResolver mapping the semantic attributes to Compose SpanStyle.

DefaultListMarkerResolver

val DefaultListMarkerResolver: ListMarkerResolver

The default ListMarkerResolver used by RichTextEditor.

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.

attributeSerializer

fun <T> attributeSerializer(key: <Error class: unknown class><T>, save: SaverScope.(value: T) -> Any?, restore: (value: Any) -> T?): AttributeSerializer<T>

Creates an AttributeSerializer using functional save and restore lambdas.

AttributeStyleResolver

fun AttributeStyleResolver(base: AttributeStyleResolver? = null, builder: AttributeStyleBuilder.() -> Unit): AttributeStyleResolver

Creates an AttributeStyleResolver using a declarative DSL. Optionally accepts a base resolver. The styles constructed by this builder will take precedence and be merged on top of the styles produced by the base resolver.

backgroundColor

fun <Error class: unknown class>.backgroundColor(color: Color)

Convenience function to set the background color using a Compose Color.

clearFormats

fun RichTextState.clearFormats()

Clears all currently active formats.

createPopupPositionProvider

fun AutocompleteMatch.createPopupPositionProvider(offset: IntOffset = IntOffset.Zero): PopupPositionProvider

Creates a PopupPositionProvider that positions a suggestion popup below (or above if constrained) the cursor of this AutocompleteMatch.

detectAndApplyLinks

fun RichTextState.detectAndApplyLinks()

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

detectAutocomplete

fun detectAutocomplete(text: CharSequence, cursorPosition: Int, triggers: List<AutocompleteTrigger>): AutocompleteMatch?

Detects whether an active autocompletion trigger pattern is present immediately before the cursor.

editAttributes

fun RichTextBuffer.editAttributes(selection: TextRange, editAction: <Error class: unknown class>.() -> Unit)

Applies a set of attribute mutations to the range specified by the given TextRange. This is a convenience overload that converts TextRange to IntRange.

fontSize

fun <Error class: unknown class>.fontSize(size: TextUnit)

Convenience function to set the font size using a Compose TextUnit.

rememberRichTextState

@Composable

fun rememberRichTextState(initialText: <Error class: unknown class> = RichString("")): RichTextState

Creates and remembers a RichTextState across configuration changes and process death using RichTextState.Saver.

@Composable

fun rememberRichTextState(initialText: <Error class: unknown class> = RichString(""), saver: Saver<RichTextState, *>): RichTextState

Creates and remembers a RichTextState with a custom saver (e.g. supporting custom attribute keys).

removeFormat

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

Removes the format associated with the given key.

RichTextEditor

@Composable

fun RichTextEditor(state: RichTextState, modifier: Modifier = Modifier, enabled: Boolean = true, readOnly: Boolean = false, textStyle: TextStyle = TextStyle.Default, keyboardOptions: KeyboardOptions = KeyboardOptions.Default, onKeyboardAction: KeyboardActionHandler? = null, lineLimits: TextFieldLineLimits = TextFieldLineLimits.Default, onTextLayout: Density.(getResult: () -> TextLayoutResult?) -> Unit? = null, scrollState: ScrollState = rememberScrollState(), interactionSource: MutableInteractionSource? = null, cursorBrush: Brush = SolidColor(Color.Black), decorator: TextFieldDecorator? = null, styleResolver: AttributeStyleResolver = DefaultAttributeStyleResolver, listMarkerResolver: ListMarkerResolver = DefaultListMarkerResolver, onSpanClick: (SpanClickEvent) -> Unit? = null, autocompleteTriggers: List<AutocompleteTrigger> = emptyList(), onAutocompleteChange: (AutocompleteMatch?) -> Unit? = null)

A basic text editor component tailored for editing and displaying RichText content.

textColor

fun <Error class: unknown class>.textColor(color: Color)

Convenience function to set the text color using a Compose Color.

toColor

fun <Error class: unknown class>.toColor(): Color

Converts an RgbaColor domain model to a Compose Color. Defaults to Color.Unspecified if the RgbaColor is unspecified.

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).

toRgbaColor

fun Color.toRgbaColor(): <Error class: unknown class>

Converts a Compose Color to an RgbaColor domain model. Defaults to RgbaColor.Unspecified if the Color is unspecified.

toTextSize

fun TextUnit.toTextSize(): <Error class: unknown class>

Converts a Compose TextUnit using 'sp' to a TextSize domain model. Defaults to TextSize.Unspecified if the TextUnit is unspecified.

toTextUnit

fun <Error class: unknown class>.toTextUnit(): TextUnit

Converts a TextSize domain model to a Compose TextUnit using 'sp'.