richtext/dev.mkeeda.arranger.richtext

Package-level declarations

Types

interface AlignmentAttributeKey<T> : ParagraphAttributeKey<T>

A category interface for paragraph attributes that control the alignment of its contents. Only one Alignment attribute can be active in a given paragraph.

AttributeContainer

class AttributeContainer

An immutable container that holds attribute keys and their values in a type-safe manner.

AttributeEditScope

class AttributeEditScope

A builder DSL for safely mutating multiple text attributes within a specific range.

AttributeKey

sealed interface AttributeKey<T>

Interface defining a key for attributes held within RichText. By having a type-safe defaultValue, it clearly defines the fallback value when an attribute is not set.

BackgroundColorKey

object BackgroundColorKey : SpanAttributeKey<RgbaColor>

The standard AttributeKey to denote the background color. Contains a RgbaColor when specified, or RgbaColor.Unspecified otherwise.

BlockquoteKey

object BlockquoteKey : BlockTypeAttributeKey<Unit>

A semantic marker indicating that the paragraph is a blockquote.

BlockTypeAttributeKey

interface BlockTypeAttributeKey<T> : ParagraphAttributeKey<T>

A category interface for paragraph attributes that dictate block structure (e.g., Heading, List, Blockquote). Only one BlockType attribute can be active in a given paragraph.

BoldKey

object BoldKey : SpanAttributeKey<Unit>

The standard AttributeKey to denote bold text.

BulletListItem

data class BulletListItem(val textIndex: Int, val indentLevel: ListIndentLevel, val color: RgbaColor?) : ListItem

Represents a bullet list item.

BulletListKey

object BulletListKey : BlockTypeAttributeKey<ListIndentLevel>

A semantic marker indicating that the paragraph is a bullet list item.

DiscoveredUrl

data class DiscoveredUrl(val range: IntRange, val rawUrl: String, val url: String)

Represents a URL discovered within a text sequence.

EnterKeyContext

data class EnterKeyContext(val text: String, val cursorPosition: Int, val paragraphRange: IntRange, val currentAttributes: AttributeContainer)

Provides the context necessary for an EnterKeyStrategy to make a decision.

EnterKeyResult

sealed interface EnterKeyResult

Represents the outcome of an EnterKeyStrategy execution.

EnterKeyStrategy

interface EnterKeyStrategy

Defines the strategy for how a paragraph should handle an Enter key press (newline insertion). This strategy determines the attributes of the newly created paragraph or modifies the current paragraph's attributes.

FontSizeKey

object FontSizeKey : SpanAttributeKey<TextSize>

The standard AttributeKey to denote the font size. Contains a TextSize when specified, or TextSize.Unspecified otherwise.

HeadingEnterStrategy

object HeadingEnterStrategy : EnterKeyStrategy

A strategy for headings. When an Enter key is pressed within or at the end of a heading, the newly created paragraph will be a standard paragraph without the heading attribute.

HeadingKey

object HeadingKey : BlockTypeAttributeKey<HeadingLevel>

A semantic marker indicating the heading level of the paragraph.

HeadingLevel

enum HeadingLevel : Enum<HeadingLevel>

Represents heading semantic levels.

InheritParagraphStrategy

object InheritParagraphStrategy : EnterKeyStrategy

A strategy that inherits the current paragraph's attributes for the new paragraph. This is the default behavior for standard paragraphs and alignment attributes.

InlineCodeKey

data object InlineCodeKey : SpanAttributeKey<Unit>

The standard AttributeKey to denote inline code text.

InternalArrangerApi

@RequiresOptIn(message = "This API is internal to Arranger and should not be used outside of it.", level = RequiresOptIn.Level.ERROR)

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])

annotation class InternalArrangerApi

ItalicKey

object ItalicKey : SpanAttributeKey<Unit>

The standard AttributeKey to denote italic text.

LinkKey

object LinkKey : SpanAttributeKey<String>

The standard AttributeKey to denote a hyperlink URL.

ListEnterStrategy

object ListEnterStrategy : EnterKeyStrategy

A strategy for list items. Handles nested lists by outdenting when an empty list item is entered.

ListIndentLevel

enum ListIndentLevel : Enum<ListIndentLevel>

Represents the indent level of a list item.

ListItem

sealed interface ListItem

Represents the semantic structure of a list item within a RichString.

OrderedListItem

data class OrderedListItem(val textIndex: Int, val indentLevel: ListIndentLevel, val color: RgbaColor?, val index: Int) : ListItem

Represents an ordered list item (e.g., 1. 2. 3.).

OrderedListKey

object OrderedListKey : BlockTypeAttributeKey<ListIndentLevel>

A semantic marker indicating that the paragraph is an ordered list item.

ParagraphAttributeKey

sealed interface ParagraphAttributeKey<T> : AttributeKey<T>

A marker interface indicating that the attribute applies to whole paragraphs.

RgbaColor

value class RgbaColor(val value: Long)

Represents a color using a 64-bit ULong to keep the model platform-independent. It perfectly aligns with Compose's Color representation or an ARGB bitmask.

RichRun

data class RichRun<T>(val text: String, val range: IntRange, val value: T)

Represents a contiguous block of text where a specific attribute is continuously applied.

RichSpan

data class RichSpan(val range: IntRange, val attributes: AttributeContainer)

Represents a span of attributes applied to a specific range within a RichString.

RichString

data class RichString(val text: String, val spans: List<RichSpan> = emptyList())

An immutable rich text representation that pairs plain text with type-safe attributes applied to specific character ranges.

RichStringScope

class RichStringScope(currentSpans: List<RichSpan>, text: String)

A DSL scope used to safely mutate the attributes of a RichString within an edit block. All mutations are accumulated internally and used to produce a completely new, immutable RichString instance when the block completes.

RichTextExporter

interface RichTextExporter<T>

An interface for exporting a RichString into a specific representation of type T.

RichTextFormat

interface RichTextFormat<T> : RichTextExporter<T> , RichTextImporter<T>

A bi-directional format that can both export a RichString to type T and import type T into a RichString.

RichTextImporter

interface RichTextImporter<T>

An interface for importing data of type T into a RichString.

SpanAttributeKey

interface SpanAttributeKey<T> : AttributeKey<T>

A marker interface indicating that the attribute applies to character spans.

StrikethroughKey

object StrikethroughKey : SpanAttributeKey<Unit>

The standard AttributeKey to denote strikethrough text.

TextAlignment

enum TextAlignment : Enum<TextAlignment>

Represents horizontal text alignment within a paragraph.

TextAlignmentKey

object TextAlignmentKey : AlignmentAttributeKey<TextAlignment>

A semantic marker indicating the horizontal text alignment of the paragraph.

TextColorKey

object TextColorKey : SpanAttributeKey<RgbaColor>

The standard AttributeKey to denote the foreground text color. Contains a RgbaColor when specified, or RgbaColor.Unspecified otherwise.

TextSize

value class TextSize(val sp: Float)

Represents a text size in scaled pixels (sp) without depending on Compose.

UnderlineKey

object UnderlineKey : SpanAttributeKey<Unit>

The standard AttributeKey to denote underlined text.

UrlParser

object UrlParser

Utility object to parse URLs from text.

Functions

attributeContainerOf

fun attributeContainerOf(): AttributeContainer

Returns an empty AttributeContainer.

fun <T> attributeContainerOf(p1: <Error class: unknown class><AttributeKey<T>, T>): AttributeContainer

Returns a new AttributeContainer containing the specified key-value p1.

fun attributeContainerOf(vararg pairs: <Error class: unknown class><AttributeKey<*>, Any?>): AttributeContainer

fun <T1, T2> attributeContainerOf(p1: <Error class: unknown class><AttributeKey<T1>, T1>, p2: <Error class: unknown class><AttributeKey<T2>, T2>): AttributeContainer

fun <T1, T2, T3> attributeContainerOf(p1: <Error class: unknown class><AttributeKey<T1>, T1>, p2: <Error class: unknown class><AttributeKey<T2>, T2>, p3: <Error class: unknown class><AttributeKey<T3>, T3>): AttributeContainer

fun <T1, T2, T3, T4> attributeContainerOf(p1: <Error class: unknown class><AttributeKey<T1>, T1>, p2: <Error class: unknown class><AttributeKey<T2>, T2>, p3: <Error class: unknown class><AttributeKey<T3>, T3>, p4: <Error class: unknown class><AttributeKey<T4>, T4>): AttributeContainer

Returns a new AttributeContainer containing the specified key-value pairs.

backgroundColor

fun AttributeEditScope.backgroundColor(color: RgbaColor)

Convenience function to set the background color within this builder.

blockquote

fun AttributeEditScope.blockquote()

Convenience function to set the blockquote attribute of the paragraph within this builder. The applied range will automatically snap to paragraph boundaries.

bold

fun AttributeEditScope.bold()

Convenience function to apply the bold text attribute within this builder.

bulletList

fun AttributeEditScope.bulletList(level: ListIndentLevel)

Convenience function to set the bullet list attribute of the paragraph within this builder. The applied range will automatically snap to paragraph boundaries.

clearBackgroundColor

fun AttributeEditScope.clearBackgroundColor()

Convenience function to remove the background color attribute in the range.

clearBlockquote

fun AttributeEditScope.clearBlockquote()

Convenience function to remove the blockquote attribute in the range.

clearBold

fun AttributeEditScope.clearBold()

Convenience function to remove the bold attribute in the range.

clearBulletList

fun AttributeEditScope.clearBulletList()

Convenience function to remove the bullet list attribute in the range.

clearFontSize

fun AttributeEditScope.clearFontSize()

Convenience function to remove the font size attribute in the range.

clearHeadingLevel

fun AttributeEditScope.clearHeadingLevel()

Convenience function to remove the heading attribute in the range.

clearInlineCode

fun AttributeEditScope.clearInlineCode()

Convenience function to remove the inline code attribute in the range.

clearItalic

fun AttributeEditScope.clearItalic()

Convenience function to remove the italic attribute in the range.

clearLink

fun AttributeEditScope.clearLink()

Convenience function to remove the link attribute in the range.

clearOrderedList

fun AttributeEditScope.clearOrderedList()

Convenience function to remove the ordered list attribute in the range.

clearStrikethrough

fun AttributeEditScope.clearStrikethrough()

Convenience function to remove the strikethrough attribute in the range.

clearTextAlignment

fun AttributeEditScope.clearTextAlignment()

Convenience function to remove the text alignment attribute in the range.

clearTextColor

fun AttributeEditScope.clearTextColor()

Convenience function to remove the text color attribute in the range.

clearUnderline

fun AttributeEditScope.clearUnderline()

Convenience function to remove the underline attribute in the range.

export

fun <T> RichString.export(exporter: RichTextExporter<T>): T

Exports this RichString using the specified exporter.

extractListItems

fun RichString.extractListItems(): List<ListItem>

Extracts a list of semantic ListItems from the given RichString.

fontSize

fun AttributeEditScope.fontSize(size: TextSize)

Convenience function to set the font size within this builder.

headingLevel

fun AttributeEditScope.headingLevel(level: HeadingLevel?)

Convenience function to set the heading level of the paragraph within this builder. The applied range will automatically snap to paragraph boundaries.

import

fun <T> RichString.Companion.import(input: T, importer: RichTextImporter<T>): RichString

Imports formatted input using the specified importer to create a RichString.

inlineCode

fun AttributeEditScope.inlineCode()

Convenience function to apply the inline code text attribute within this builder.

italic

fun AttributeEditScope.italic()

Convenience function to apply the italic text attribute within this builder.

link

fun AttributeEditScope.link(url: String)

Convenience function to set the link attribute within this builder.

mergeSpan

fun List<RichSpan>.mergeSpan(newSpan: RichSpan): List<RichSpan>

Merges a newSpan into this list of spans. Convenience extension that wraps transformSpans.

orderedList

fun AttributeEditScope.orderedList(level: ListIndentLevel)

Convenience function to set the ordered list attribute of the paragraph within this builder. The applied range will automatically snap to paragraph boundaries.

rangeOf

fun CharSequence.rangeOf(substring: String): IntRange

Returns the index range of the first occurrence of the specified substring within this character sequence. This is useful for easily specifying ranges when applying rich text attributes.

rangesOf

fun CharSequence.rangesOf(regex: <Error class: unknown class>): <Error class: unknown class><IntRange>

Returns a lazily evaluated sequence of all occurrence ranges of the specified regex within this character sequence.

fun CharSequence.rangesOf(target: String, ignoreCase: Boolean = false): <Error class: unknown class><IntRange>

Returns a lazily evaluated sequence of all occurrence ranges of the specified target within this character sequence.

resnapParagraphSpans

fun List<RichSpan>.resnapParagraphSpans(text: String): List<RichSpan>

Re-snaps any spans containing ParagraphAttributeKeys to align with paragraph boundaries in the given text.

snapToParagraphs

fun IntRange.snapToParagraphs(text: String): IntRange

Expands this range to cover the entire paragraph(s) it intersects with in the given text. Paragraphs are delimited by '\n'.

strikethrough

fun AttributeEditScope.strikethrough()

Convenience function to apply the strikethrough text attribute within this builder.

textAlignment

fun AttributeEditScope.textAlignment(alignment: TextAlignment?)

Convenience function to set the text alignment of the paragraph within this builder. The applied range will automatically snap to paragraph boundaries.

textColor

fun AttributeEditScope.textColor(color: RgbaColor)

Convenience function to set the text color within this builder.

underline

fun AttributeEditScope.underline()

Convenience function to apply the underline text attribute within this builder.