Revision control
Copy as Markdown
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
package org.mozilla.focus.utils
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.text.ClickableText
import androidx.compose.material.Text
import androidx.compose.runtime.Composable
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.res.colorResource
import androidx.compose.ui.text.SpanStyle
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.text.buildAnnotatedString
import androidx.compose.ui.text.style.TextDecoration
import androidx.compose.ui.tooling.preview.Preview
import androidx.compose.ui.unit.sp
import org.mozilla.focus.R
import org.mozilla.focus.ui.theme.FocusTheme
import org.mozilla.focus.ui.theme.focusTypography
/**
* [Text] containing a substring styled as an URL informing when this is clicked.
*
* @param text Full text that will be displayed
* @param textColor [Color] of the normal text. The URL substring will have a default URL style applied.
* @param linkTextColor [Color] of the link text.
* @param style of the text
* @param linkTextDecoration The decorations to paint on the link text (e.g., an underline).
* @param clickableStartIndex [text] index at which the URL substring starts.
* @param clickableEndIndex [text] index at which the URL substring ends.
* @param onClick Callback to be invoked only when the URL substring is clicked.
*/
@Composable
fun ClickableSubstringLink(
text: String,
textColor: Color = colorResource(R.color.cfr_text_color),
linkTextColor: Color = colorResource(R.color.cfr_text_color),
style: TextStyle = focusTypography.body1,
linkTextDecoration: TextDecoration? = null,
clickableStartIndex: Int,
clickableEndIndex: Int,
onClick: () -> Unit,
) {
val annotatedText = buildAnnotatedString {
append(text)
addStyle(
SpanStyle(textColor),
start = 0,
end = clickableStartIndex,
)
addStyle(
SpanStyle(
color = linkTextColor,
textDecoration = linkTextDecoration,
),
start = clickableStartIndex,
end = clickableEndIndex,
)
addStyle(
SpanStyle(textColor),
start = clickableEndIndex,
end = text.length,
)
addStyle(
SpanStyle(fontSize = 12.sp),
start = 0,
end = clickableEndIndex,
)
addStringAnnotation(
tag = "link",
annotation = "",
start = clickableStartIndex,
end = clickableEndIndex,
)
}
ClickableText(
text = annotatedText,
style = style,
onClick = {
annotatedText
.getStringAnnotations("link", it, it)
.firstOrNull()?.let {
onClick()
}
},
)
}
@Composable
@Preview
private fun ClickableSubstringTextPreview() {
val text = "This text contains a link"
FocusTheme {
Box {
ClickableSubstringLink(
text = text,
linkTextDecoration = TextDecoration.Underline,
clickableStartIndex = text.indexOf("link"),
clickableEndIndex = text.length,
) { }
}
}
}