net.peanuuutz.fork.ui.foundation.text.ClickableText.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fork-ui Show documentation
Comprehensive API designed for Minecraft modders
The newest version!
/*
 * Copyright 2020 The Android Open Source Project
 * Modifications Copyright 2022 Peanuuutz
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.peanuuutz.fork.ui.foundation.text

import androidx.compose.runtime.Composable
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberUpdatedState
import net.peanuuutz.fork.ui.foundation.input.detectPressRelease
import net.peanuuutz.fork.ui.ui.draw.text.Paragraph
import net.peanuuutz.fork.ui.ui.draw.text.TextStyle
import net.peanuuutz.fork.ui.ui.modifier.Modifier
import net.peanuuutz.fork.ui.ui.modifier.input.PointerInputScope
import net.peanuuutz.fork.ui.ui.modifier.input.pointerInput

@Composable
fun ClickableText(
    paragraph: Paragraph,
    onClick: (charIndex: Int) -> Unit,
    modifier: Modifier = Modifier,
    ignoreClickOnGap: Boolean = true,
    textStyle: TextStyle = LocalTextStyle.current,
    overflow: TextOverflow = TextOverflow.Clip,
    softWrap: Boolean = true,
    maxLines: Int = Int.MAX_VALUE,
    onTextLayout: ((TextLayoutResult) -> Unit)? = null,
    selector: TextSelector? = null
) {
    val layoutResultState = remember { mutableStateOf(null) }
    val ignoreClickOnGapState = rememberUpdatedState(ignoreClickOnGap)
    val onClickState = rememberUpdatedState(onClick)

    BasicText(
        paragraph = paragraph,
        modifier = modifier.pointerInput {
            detectClickOnText(
                layoutResultProvider = layoutResultState::value,
                ignoreClickOnGapProvider = ignoreClickOnGapState::value,
                onClickProvider = onClickState::value
            )
        },
        textStyle = textStyle,
        overflow = overflow,
        softWrap = softWrap,
        maxLines = maxLines,
        onTextLayout = { result ->
            layoutResultState.value = result
            onTextLayout?.invoke(result)
        },
        selector = selector
    )
}

// Internal

internal suspend fun PointerInputScope.detectClickOnText(
    layoutResultProvider: () -> TextLayoutResult?,
    ignoreClickOnGapProvider: () -> Boolean,
    onClickProvider: () -> ((Int) -> Unit)
) {
    detectPressRelease { tapEvent ->
        val result = layoutResultProvider() ?: return@detectPressRelease
        val pressedCharIndex = if (ignoreClickOnGapProvider()) {
            result.measuredParagraph.getCharIndexFromOffsetExactly(tapEvent.position)
        } else {
            result.measuredParagraph.getCharIndexFromOffsetApproximately(tapEvent.position)
        }
        onClickProvider()(pressedCharIndex) // Do not filter NullIndex here
    }
}