viewcompose-text-core/com.viewcompose.text

Package-level declarations

Types

data class InlineAttachmentRange(val offset: Int, val attachment: InlineTextAttachment)

Binds one attachment to an object-replacement character at offset.

class InlineTextAttachment(val id: String, val mimeType: String, val uri: String? = null, val contentDescription: String? = null, val widthPx: Int? = null, val heightPx: Int? = null, metadata: Map<String, String> = emptyMap())

Immutable metadata for one non-text inline attachment.

InputTransformation

fun interface InputTransformation

Validates or rewrites a platform-proposed edit before TextFieldState commits it.

ParagraphStyle

data class ParagraphStyle(val alignment: ParagraphTextAlignment? = null, val lineHeightPx: Float? = null, val firstLineIndentPx: Float = 0.0f, val restLineIndentPx: Float = 0.0f, val bullet: TextBullet? = null)

Immutable paragraph-level rich-text style.

ParagraphStyleRange

data class ParagraphStyleRange(val range: TextRange, val style: ParagraphStyle)

Associates paragraph style with an ordered, document-bounded UTF-16 range.

ParagraphTextAlignment

enum ParagraphTextAlignment : Enum<ParagraphTextAlignment>

Logical horizontal alignment for a paragraph.

ReceiveContentConfiguration

class ReceiveContentConfiguration(mimeTypes: Set<String> = DefaultMimeTypes, val transformation: ReceiveContentTransformation? = null)

Defines the accepted MIME patterns and optional conversion policy for receive-content.

ReceiveContentSource

enum ReceiveContentSource : Enum<ReceiveContentSource>

Source category assigned to content entering a text field from outside ordinary typing.

ReceiveContentTransformation

fun interface ReceiveContentTransformation

Decides whether and how normalized external content is inserted into a text field.

ReceivedContent

data class ReceivedContent(val document: TextDocument, val source: ReceiveContentSource, val mimeTypes: Set<String>, val platformItemCount: Int)

Immutable, platform-neutral content normalized from one external receive-content payload.

TextBullet

data class TextBullet(val radiusPx: Float = 3.0f, val gapWidthPx: Float = 8.0f, val color: Int? = null)

Immutable paragraph bullet geometry.

TextDocument

class TextDocument(val text: String, spanStyles: List<TextSpanRange> = emptyList(), paragraphStyles: List<ParagraphStyleRange> = emptyList(), inlineAttachments: List<InlineAttachmentRange> = emptyList())

Immutable rich-text document containing text, span styles, paragraph styles, and attachments.

TextDocumentBuilder

class TextDocumentBuilder

Mutable builder for incrementally creating one validated TextDocument.

TextDocumentSaveCodec

object TextDocumentSaveCodec

Versioned, platform-neutral save codec for complete TextDocument values.

TextFieldBuffer

class TextFieldBuffer

Mutable transaction buffer used by programmatic edits and input transformations.

TextFieldState

class TextFieldState(initialValue: TextFieldValue = TextFieldValue(""), val historyLimit: Int = DEFAULT_HISTORY_LIMIT)

Stable observable owner of editable text, selection, IME composition, and undo history.

TextFieldValue

data class TextFieldValue(val document: TextDocument, val selection: TextRange = TextRange(document.text.length), val composition: TextRange? = null)

Immutable snapshot of a complete editable text-field value.

TextFontStyle

enum TextFontStyle : Enum<TextFontStyle>

Requested font posture for a text span.

TextRange

data class TextRange(val start: Int, val end: Int = start)

Directional UTF-16 range used by platform text-editing contracts.

TextSpanRange

data class TextSpanRange(val range: TextRange, val style: TextSpanStyle)

Associates style with an ordered, document-bounded UTF-16 range.

TextSpanStyle

data class TextSpanStyle(val color: Int? = null, val backgroundColor: Int? = null, val fontWeight: Int? = null, val fontStyle: TextFontStyle? = null, val relativeSize: Float? = null, val underline: Boolean = false, val lineThrough: Boolean = false, val verticalAlignment: TextVerticalAlignment = TextVerticalAlignment.Normal, val link: String? = null)

Immutable character-level rich-text style.

TextVerticalAlignment

enum TextVerticalAlignment : Enum<TextVerticalAlignment>

Vertical placement of a span relative to the surrounding text baseline.

Properties

INLINE_ATTACHMENT_CHARACTER

const val INLINE_ATTACHMENT_CHARACTER: Char = '\uFFFC'

Unicode object-replacement character reserved for inline attachment positions.

Functions

textDocument

fun textDocument(block: TextDocumentBuilder.() -> Unit): TextDocument

Builds a validated rich-text document with block.

then

fun InputTransformation.then(next: InputTransformation): InputTransformation

Returns a policy that applies this transformation and then next to the same buffer.