interactive-text/me.okonecny.interactivetext

Package-level declarations

Types

BoundedBlockTextMapping

class BoundedBlockTextMapping(val coveredSourceRange: TextRange, visualTextRange: TextRange? = null) : TextMapping

ChunkedSourceTextMapping

class ChunkedSourceTextMapping(chunks: List<TextMapping>) : TextMapping

Copy

data object Copy : TextInputCommand

CursorPosition

data class CursorPosition(val componentId: InteractiveId, val visualOffset: Int)

Used as mutable state. Must stay a value object.

Cut

data object Cut : TextInputCommand

Delete

data class Delete(val direction: Delete.Direction, val size: Delete.Size) : TextInputCommand

InteractiveComponent

data class InteractiveComponent(val id: InteractiveId, val scrollIndex: Int?, layoutCoordinates: LayoutCoordinates?, val visualTextRange: TextRange, val textMapping: TextMapping, val textLayoutResult: TextLayoutResult?, val userData: UserData = UserData.empty)

Class representing an interactive GUI element. Best created in onGloballyPositioned modifier.

InteractiveId

typealias InteractiveId = Long

InteractiveScope

data class InteractiveScope(val focusRequester: FocusRequester = FocusRequester(), containerLayoutCoordinates: LayoutCoordinates? = null)

LinearInteractiveIdGenerator

class LinearInteractiveIdGenerator

NavigableLazyListScope

data class NavigableLazyListScope(lazyListScope: LazyListScope, val navigation: Navigation)

Navigation

interface Navigation

NewLine

data object NewLine : TextInputCommand

Paste

data object Paste : TextInputCommand

Redo

data object Redo : TextInputCommand

ReplaceRange

data class ReplaceRange(val sourceRange: TextRange, val newSource: String, val sourceCursorOffset: Int = 0) : TextInputCommand

ScrollPageDown

class ScrollPageDown(val fraction: Float = 1.0f) : ScrollRequest

ScrollPageUp

class ScrollPageUp(val fraction: Float = 1.0f) : ScrollRequest

ScrollRequest

sealed interface ScrollRequest

ScrollToAnchor

data class ScrollToAnchor(val anchor: String) : ScrollRequest

ScrollToComponent

data class ScrollToComponent(val interactiveComponent: InteractiveComponent) : ScrollRequest

ScrollToIndex

data class ScrollToIndex(val scrollIndex: Int) : ScrollRequest

ScrollToMakeVisible

data class ScrollToMakeVisible(val range: IntRange) : ScrollRequest

Selection

data class Selection(val start: CursorPosition, val end: CursorPosition)

SelectionStyle

data class SelectionStyle(val fillColor: Color = Color.Cyan.copy(alpha = 0.5f), val stroke: SelectionStyle.Stroke = Stroke())

TextInputCommand

sealed interface TextInputCommand

TextMapping

interface TextMapping

Maps ranges of rendered text to ranges of source code and back.

Type

data class Type(val text: String) : TextInputCommand

Undo

data object Undo : TextInputCommand

UserData

data class UserData(val dataByType: Map<KClass<*>, Any> = emptyMap())

ZeroTextMapping

object ZeroTextMapping : TextMapping

Properties

LocalInteractiveInputHandler

val LocalInteractiveInputHandler: ProvidableCompositionLocal<(TextInputCommand) -> Unit>

LocalInteractiveScope

val LocalInteractiveScope: ProvidableCompositionLocal<InteractiveScope?>

LocalNavigation

val LocalNavigation: ProvidableCompositionLocal<Navigation>

LocalScrollIndex

val LocalScrollIndex: ProvidableCompositionLocal<Int?>

LocalSelectionStyle

val LocalSelectionStyle: ProvidableCompositionLocal<SelectionStyle>

Functions

annotationClickDetector

fun Modifier.annotationClickDetector(textLayoutResult: TextLayoutResult?, activeTags: Set<String>, activePointerIcon: PointerIcon = PointerIcon.Hand, onClick: (Int, List<AnnotatedString.Range<String>>) -> Unit): Modifier

Detects annotations tagged by a specific tag in the annotated text, which is shown in the component. If a mouse pointer hovers over such text, its icon is changed and if clicked, the onClick handler will be called.

cursorVisualRect

fun InteractiveScope.cursorVisualRect(cursorPosition: CursorPosition): Rect?

Find the visual position of the cursor in the layout.

DisabledInteractiveContainer

@Composable

fun DisabledInteractiveContainer(interactiveContent: @Composable () -> Unit)

Delimits a region where interaction is disabled.

ensureCursorIsVisible

fun Navigation.ensureCursorIsVisible(scope: InteractiveScope?)

InteractiveContainer

@Composable

fun InteractiveContainer(scope: InteractiveScope? = rememberInteractiveScope(), selectionStyle: SelectionStyle = SelectionStyle(), modifier: Modifier = Modifier, onInput: (TextInputCommand) -> Unit = {}, onCursorMovement: (CursorPosition) -> Unit = { scope?.cursorPosition = it }, interactiveContent: @Composable () -> Unit)

Delimits region where all the interactive components will be considered parts of the same document.

InteractiveText

@Composable

fun InteractiveText(interactiveId: InteractiveId, text: String, textMapping: TextMapping, style: TextStyle, modifier: Modifier = Modifier, userData: UserData = UserData.empty, activeAnnotationTags: Set<String> = setOf(), onAnnotationCLick: (Int, List<AnnotatedString.Range<String>>) -> Unit = { _, _ -> })

@Composable

fun InteractiveText(interactiveId: InteractiveId, text: AnnotatedString, textMapping: TextMapping, style: TextStyle, modifier: Modifier = Modifier, inlineContent: Map<String, InlineTextContent> = mapOf(), userData: UserData = UserData.empty, activeAnnotationTags: Set<String> = setOf(), onAnnotationCLick: (Int, List<AnnotatedString.Range<String>>) -> Unit = { _, _ -> })

interactiveText

fun Modifier.interactiveText(interactiveId: InteractiveId, textLayoutResult: TextLayoutResult?, textMapping: TextMapping, textLength: Int, userData: UserData = UserData.empty): Modifier

moveCursorByWord

fun InteractiveScope.moveCursorByWord(oldPosition: CursorPosition, moveStep: (CursorPosition) -> CursorPosition): CursorPosition

moveCursorDown

fun InteractiveScope.moveCursorDown(oldPosition: CursorPosition): CursorPosition

moveCursorHome

fun InteractiveScope.moveCursorHome(oldPosition: CursorPosition): CursorPosition

moveCursorLeft

fun InteractiveScope.moveCursorLeft(oldPosition: CursorPosition): CursorPosition

moveCursorLeftByWord

fun InteractiveScope.moveCursorLeftByWord(oldPosition: CursorPosition): CursorPosition

moveCursorRight

fun InteractiveScope.moveCursorRight(oldPosition: CursorPosition): CursorPosition

moveCursorRightByWord

fun InteractiveScope.moveCursorRightByWord(oldPosition: CursorPosition): CursorPosition

moveCursorToEnd

fun InteractiveScope.moveCursorToEnd(oldPosition: CursorPosition): CursorPosition

moveCursorUp

fun InteractiveScope.moveCursorUp(oldPosition: CursorPosition): CursorPosition

NavigableLazyColumn

@Composable

fun NavigableLazyColumn(modifier: Modifier = Modifier, state: LazyListState = rememberLazyListState(), contentPadding: PaddingValues = PaddingValues(0.dp), reverseLayout: Boolean = false, verticalArrangement: Arrangement.Vertical = if (!reverseLayout) Arrangement.Top else Arrangement.Bottom, horizontalAlignment: Alignment.Horizontal = Alignment.Start, flingBehavior: FlingBehavior = ScrollableDefaults.flingBehavior(), userScrollEnabled: Boolean = true, navigation: Navigation = LocalNavigation.current, content: NavigableLazyListScope.() -> Unit)

paintSelection

fun Modifier.paintSelection(interactiveScope: InteractiveScope, interactiveId: InteractiveId): Modifier

plus

operator fun TextMapping.plus(other: TextMapping): TextMapping

rememberInteractiveScope

@Composable

fun rememberInteractiveScope(vararg keys: Any?): InteractiveScope

textInput

fun Modifier.textInput(onInput: (TextInputCommand) -> Unit): Modifier