Migrated to LinkAnnotation design

halilozercan · halilozercan · commit 69af671d04c1 · 2024-12-05T01:51:46.000Z
This change removes linkClickHandlers. Now `Format.Link` accepts its own handler. If left null, LocalUriHandler is used instead.
diff --git a/android-sample/src/main/java/com/zachklipp/richtext/sample/LazyMarkdownSample.kt b/android-sample/src/main/java/com/zachklipp/richtext/sample/LazyMarkdownSample.kt
@@ -18,6 +18,7 @@ import androidx.compose.material3.Text
 import androidx.compose.material3.darkColorScheme
 import androidx.compose.material3.lightColorScheme
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.CompositionLocalProvider
 import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
@@ -27,6 +28,8 @@ import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.platform.LocalContext
 import androidx.compose.ui.platform.LocalDensity
+import androidx.compose.ui.platform.LocalUriHandler
+import androidx.compose.ui.platform.UriHandler
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
 import com.halilibo.richtext.commonmark.CommonMarkdownParseOptions
@@ -115,14 +118,13 @@ import com.halilibo.richtext.ui.resolveDefaults
             parser.parse(sampleMarkdown)
           }
 
-          RichText(
-            style = richTextStyle,
-            linkClickHandler = {
-              Toast.makeText(context, it, Toast.LENGTH_SHORT).show()
-            },
-            modifier = Modifier.padding(8.dp),
-          ) {
-            LazyMarkdown(astNode)
+          ProvideToastUriHandler(context) {
+            RichText(
+              style = richTextStyle,
+              modifier = Modifier.padding(8.dp),
+            ) {
+              LazyMarkdown(astNode)
+            }
           }
         }
       }
diff --git a/android-sample/src/main/java/com/zachklipp/richtext/sample/MarkdownSample.kt b/android-sample/src/main/java/com/zachklipp/richtext/sample/MarkdownSample.kt
@@ -133,14 +133,13 @@ import com.halilibo.richtext.ui.resolveDefaults
                 parser.parse(sampleMarkdown)
               }
 
-              RichText(
-                style = richTextStyle,
-                linkClickHandler = {
-                  Toast.makeText(context, it, Toast.LENGTH_SHORT).show()
-                },
-                modifier = Modifier.padding(8.dp),
-              ) {
-                BasicMarkdown(astNode, HeadingAstBlockNodeComposer)
+              ProvideToastUriHandler(context) {
+                RichText(
+                  style = richTextStyle,
+                  modifier = Modifier.padding(8.dp),
+                ) {
+                  BasicMarkdown(astNode, HeadingAstBlockNodeComposer)
+                }
               }
             }
           }
diff --git a/android-sample/src/main/java/com/zachklipp/richtext/sample/TextDemo.kt b/android-sample/src/main/java/com/zachklipp/richtext/sample/TextDemo.kt
@@ -1,5 +1,7 @@
 package com.zachklipp.richtext.sample
 
+import android.content.Context
+import android.widget.Toast
 import androidx.compose.animation.Animatable
 import androidx.compose.animation.core.Animatable
 import androidx.compose.animation.core.LinearEasing
@@ -14,6 +16,7 @@ import androidx.compose.foundation.layout.size
 import androidx.compose.foundation.layout.wrapContentSize
 import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.CompositionLocalProvider
 import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
@@ -28,6 +31,8 @@ import androidx.compose.ui.graphics.StrokeCap.Companion.Round
 import androidx.compose.ui.graphics.drawscope.withTransform
 import androidx.compose.ui.graphics.graphicsLayer
 import androidx.compose.ui.platform.LocalContext
+import androidx.compose.ui.platform.LocalUriHandler
+import androidx.compose.ui.platform.UriHandler
 import androidx.compose.ui.text.TextStyle
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
@@ -65,7 +70,7 @@ import kotlinx.coroutines.launch
       appendPreviewSentence(Superscript)
       appendPreviewSentence(Code)
       appendPreviewSentence(
-        Link(""),
+        Link("") { toggleLink = !toggleLink },
         if (toggleLink) "clicked link" else "link"
       )
       append("Here, ")
@@ -96,7 +101,7 @@ import kotlinx.coroutines.launch
       }
     }
   }
-  RichText(linkClickHandler = { toggleLink = !toggleLink }) {
+  RichText {
     Text(text)
   }
 }
@@ -213,3 +218,16 @@ private fun Builder.appendPreviewSentence(
   }
   append(" text. ")
 }
+
+@Composable
+fun ProvideToastUriHandler(context: Context, content: @Composable () -> Unit) {
+  val uriHandler = remember(context) {
+    object : UriHandler {
+      override fun openUri(uri: String) {
+        Toast.makeText(context, uri, Toast.LENGTH_SHORT).show()
+      }
+    }
+  }
+
+  CompositionLocalProvider(LocalUriHandler provides uriHandler, content)
+}
diff --git a/desktop-sample/src/main/kotlin/com/halilibo/richtext/desktop/MarkdownSampleApp.kt b/desktop-sample/src/main/kotlin/com/halilibo/richtext/desktop/MarkdownSampleApp.kt
@@ -34,6 +34,8 @@ import androidx.compose.runtime.setValue
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.platform.LocalDensity
+import androidx.compose.ui.platform.LocalUriHandler
+import androidx.compose.ui.platform.UriHandler
 import androidx.compose.ui.unit.dp
 import androidx.compose.ui.unit.sp
 import androidx.compose.ui.window.singleWindowApplication
@@ -103,30 +105,26 @@ fun main(): Unit = singleWindowApplication(
                   icon = { Icon(Icons.Default.Favorite, "") })
               }
             }
-            if (selectedTab == 0) {
-              RichText(
-                modifier = Modifier.verticalScroll(rememberScrollState()),
-                style = richTextStyle,
-                linkClickHandler = {
-                  println("Link clicked destination=$it")
+            ProvidePrintUriHandler {
+              if (selectedTab == 0) {
+                RichText(
+                  modifier = Modifier.verticalScroll(rememberScrollState()),
+                  style = richTextStyle,
+                ) {
+                  Markdown(content = text)
                 }
-              ) {
-                Markdown(content = text)
-              }
-            } else {
-              val parser = remember { CommonmarkAstNodeParser() }
+              } else {
+                val parser = remember { CommonmarkAstNodeParser() }
 
-              val astNode = remember(parser) {
-                parser.parse(sampleMarkdown)
-              }
+                val astNode = remember(parser) {
+                  parser.parse(sampleMarkdown)
+                }
 
-              RichText(
-                style = richTextStyle,
-                linkClickHandler = {
-                  println("Link clicked destination=$it")
+                RichText(
+                  style = richTextStyle,
+                ) {
+                  LazyMarkdown(astNode)
                 }
-              ) {
-                LazyMarkdown(astNode)
               }
             }
           }
@@ -242,6 +240,19 @@ fun RichTextStyleConfig(
   }
 }
 
+@Composable
+fun ProvidePrintUriHandler(content: @Composable () -> Unit) {
+  val uriHandler = remember {
+    object : UriHandler {
+      override fun openUri(uri: String) {
+        println("Link clicked destination=$uri")
+      }
+    }
+  }
+
+  CompositionLocalProvider(LocalUriHandler provides uriHandler, content)
+}
+
 private val sampleMarkdown = """
   # Demo
   Based on [this cheatsheet][cheatsheet]
diff --git a/desktop-sample/src/main/kotlin/com/halilibo/richtext/desktop/RichTextSampleApp.kt b/desktop-sample/src/main/kotlin/com/halilibo/richtext/desktop/RichTextSampleApp.kt
@@ -229,7 +229,7 @@ fun main(): Unit = singleWindowApplication(
       appendPreviewSentence(Superscript)
       appendPreviewSentence(Code)
       appendPreviewSentence(
-        Link(""),
+        Link("") { toggleLink = !toggleLink },
         if (toggleLink) "clicked link" else "link"
       )
       append("Here, ")
@@ -260,7 +260,7 @@ fun main(): Unit = singleWindowApplication(
       }
     }
   }
-  RichText(linkClickHandler = { toggleLink = !toggleLink }) {
+  RichText {
     Text(text)
   }
 }
diff --git a/richtext-ui-material/src/commonMain/kotlin/com/halilibo/richtext/ui/material/RichText.kt b/richtext-ui-material/src/commonMain/kotlin/com/halilibo/richtext/ui/material/RichText.kt
@@ -8,7 +8,6 @@ import androidx.compose.runtime.CompositionLocalProvider
 import androidx.compose.runtime.compositionLocalOf
 import androidx.compose.ui.Modifier
 import com.halilibo.richtext.ui.BasicRichText
-import com.halilibo.richtext.ui.LinkClickHandler
 import com.halilibo.richtext.ui.RichTextScope
 import com.halilibo.richtext.ui.RichTextStyle
 import com.halilibo.richtext.ui.RichTextThemeProvider
@@ -24,14 +23,12 @@ import com.halilibo.richtext.ui.RichTextThemeProvider
 public fun RichText(
   modifier: Modifier = Modifier,
   style: RichTextStyle? = null,
-  linkClickHandler: LinkClickHandler? = null,
   children: @Composable RichTextScope.() -> Unit
 ) {
   RichTextMaterialTheme {
     BasicRichText(
       modifier = modifier,
       style = style,
-      linkClickHandler = linkClickHandler,
       children = children
     )
   }
diff --git a/richtext-ui-material3/src/commonMain/kotlin/com/halilibo/richtext/ui/material3/RichText.kt b/richtext-ui-material3/src/commonMain/kotlin/com/halilibo/richtext/ui/material3/RichText.kt
@@ -8,7 +8,6 @@ import androidx.compose.runtime.CompositionLocalProvider
 import androidx.compose.runtime.compositionLocalOf
 import androidx.compose.ui.Modifier
 import com.halilibo.richtext.ui.BasicRichText
-import com.halilibo.richtext.ui.LinkClickHandler
 import com.halilibo.richtext.ui.RichTextScope
 import com.halilibo.richtext.ui.RichTextStyle
 import com.halilibo.richtext.ui.RichTextThemeProvider
@@ -24,14 +23,12 @@ import com.halilibo.richtext.ui.RichTextThemeProvider
 public fun RichText(
   modifier: Modifier = Modifier,
   style: RichTextStyle? = null,
-  linkClickHandler: LinkClickHandler? = null,
   children: @Composable RichTextScope.() -> Unit
 ) {
   RichTextMaterialTheme {
     BasicRichText(
       modifier = modifier,
       style = style,
-      linkClickHandler = linkClickHandler,
       children = children
     )
   }
diff --git a/richtext-ui/src/commonMain/kotlin/com/halilibo/richtext/ui/BasicRichText.kt b/richtext-ui/src/commonMain/kotlin/com/halilibo/richtext/ui/BasicRichText.kt
@@ -5,7 +5,6 @@ package com.halilibo.richtext.ui
 import androidx.compose.foundation.layout.Arrangement.spacedBy
 import androidx.compose.foundation.layout.Column
 import androidx.compose.runtime.Composable
-import androidx.compose.runtime.CompositionLocalProvider
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.platform.LocalDensity
 
@@ -16,21 +15,18 @@ import androidx.compose.ui.platform.LocalDensity
 public fun BasicRichText(
   modifier: Modifier = Modifier,
   style: RichTextStyle? = null,
-  linkClickHandler: LinkClickHandler? = null,
   children: @Composable RichTextScope.() -> Unit
 ) {
   with(RichTextScope) {
     RestartListLevel {
       WithStyle(style) {
-        CompositionLocalProvider(LocalLinkClickHandler provides linkClickHandler) {
-          val resolvedStyle = currentRichTextStyle.resolveDefaults()
-          val blockSpacing = with(LocalDensity.current) {
-            resolvedStyle.paragraphSpacing!!.toDp()
-          }
+        val resolvedStyle = currentRichTextStyle.resolveDefaults()
+        val blockSpacing = with(LocalDensity.current) {
+          resolvedStyle.paragraphSpacing!!.toDp()
+        }
 
-          Column(modifier = modifier, verticalArrangement = spacedBy(blockSpacing)) {
-            children()
-          }
+        Column(modifier = modifier, verticalArrangement = spacedBy(blockSpacing)) {
+          children()
         }
       }
     }
diff --git a/richtext-ui/src/commonMain/kotlin/com/halilibo/richtext/ui/FormattedList.kt b/richtext-ui/src/commonMain/kotlin/com/halilibo/richtext/ui/FormattedList.kt
@@ -204,7 +204,6 @@ private val LocalListLevel = compositionLocalOf { 0 }
   val contentsIndent = with(density) { listStyle.contentsIndent!!.toDp() }
   val itemSpacing = with(density) { listStyle.itemSpacing!!.toDp() }
   val currentLevel = LocalListLevel.current
-  val currentLinkClickHandler = LocalLinkClickHandler.current
 
   PrefixListLayout(
     count = items.size,
@@ -219,7 +218,6 @@ private val LocalListLevel = compositionLocalOf { 0 }
     itemForIndex = { index ->
       BasicRichText(
         style = currentRichTextStyle.copy(paragraphSpacing = listStyle.itemSpacing),
-        linkClickHandler = currentLinkClickHandler
       ) {
         CompositionLocalProvider(LocalListLevel provides currentLevel + 1) {
           drawItem(items[index])
diff --git a/richtext-ui/src/commonMain/kotlin/com/halilibo/richtext/ui/LinkClickHandler.kt b/richtext-ui/src/commonMain/kotlin/com/halilibo/richtext/ui/LinkClickHandler.kt
diff --git a/richtext-ui/src/commonMain/kotlin/com/halilibo/richtext/ui/RichTextLocals.kt b/richtext-ui/src/commonMain/kotlin/com/halilibo/richtext/ui/RichTextLocals.kt
@@ -97,46 +97,3 @@ internal fun RichTextScope.Text(
     inlineContent = inlineContent
   )
 }
-
-/**
- * Default ClickableText implementation from Compose does not take inlineContent for some reason.
- * Instead of replicating the same behavior inside [Text] that takes [RichTextString], we separate
- * the logic into our own [ClickableText].
- */
-@Composable
-internal fun RichTextScope.ClickableText(
-  text: AnnotatedString,
-  modifier: Modifier = Modifier,
-  softWrap: Boolean = true,
-  overflow: TextOverflow = TextOverflow.Clip,
-  maxLines: Int = Int.MAX_VALUE,
-  onTextLayout: (TextLayoutResult) -> Unit = {},
-  inlineContent: Map<String, InlineTextContent> = mapOf(),
-  isOffsetClickable: (Int) -> Boolean,
-  onClick: (Int) -> Unit
-) {
-  val layoutResult = remember { mutableStateOf<TextLayoutResult?>(null) }
-  val shouldHandle = { pos: Offset ->
-    layoutResult.value?.getOffsetForPosition(pos)?.let { isOffsetClickable(it) } ?: false
-  }
-  val pressIndicator = Modifier.pointerInput(onClick) {
-    detectTapGesturesIf(predicate = shouldHandle) { pos ->
-      layoutResult.value?.let { layoutResult ->
-        onClick(layoutResult.getOffsetForPosition(pos))
-      }
-    }
-  }
-
-  Text(
-    text = text,
-    modifier = modifier.then(pressIndicator),
-    softWrap = softWrap,
-    overflow = overflow,
-    maxLines = maxLines,
-    onTextLayout = {
-      layoutResult.value = it
-      onTextLayout(it)
-    },
-    inlineContent = inlineContent
-  )
-}
diff --git a/richtext-ui/src/commonMain/kotlin/com/halilibo/richtext/ui/string/RichTextString.kt b/richtext-ui/src/commonMain/kotlin/com/halilibo/richtext/ui/string/RichTextString.kt
diff --git a/richtext-ui/src/commonMain/kotlin/com/halilibo/richtext/ui/string/Text.kt b/richtext-ui/src/commonMain/kotlin/com/halilibo/richtext/ui/string/Text.kt

Original file line number	Diff line number	Diff line change
`@@ -133,14 +133,13 @@ import com.halilibo.richtext.ui.resolveDefaults`
`133`	`133`	`parser.parse(sampleMarkdown)`
`134`	`134`	`}`
`135`	`135`
`136`		`- RichText(`
`137`		`- style = richTextStyle,`
`138`		`- linkClickHandler = {`
`139`		`- Toast.makeText(context, it, Toast.LENGTH_SHORT).show()`
`140`		`- },`
`141`		`- modifier = Modifier.padding(8.dp),`
`142`		`- ) {`
`143`		`- BasicMarkdown(astNode, HeadingAstBlockNodeComposer)`
	`136`	`+ ProvideToastUriHandler(context) {`
	`137`	`+ RichText(`
	`138`	`+ style = richTextStyle,`
	`139`	`+ modifier = Modifier.padding(8.dp),`
	`140`	`+ ) {`
	`141`	`+ BasicMarkdown(astNode, HeadingAstBlockNodeComposer)`
	`142`	`+ }`
`144`	`143`	`}`
`145`	`144`	`}`
`146`	`145`	`}`
Original file line number	Diff line number	Diff line change
`@@ -229,7 +229,7 @@ fun main(): Unit = singleWindowApplication(`
`229`	`229`	`appendPreviewSentence(Superscript)`
`230`	`230`	`appendPreviewSentence(Code)`
`231`	`231`	`appendPreviewSentence(`
`232`		`- Link(""),`
	`232`	`+ Link("") { toggleLink = !toggleLink },`
`233`	`233`	`if (toggleLink) "clicked link" else "link"`
`234`	`234`	`)`
`235`	`235`	`append("Here, ")`
`@@ -260,7 +260,7 @@ fun main(): Unit = singleWindowApplication(`
`260`	`260`	`}`
`261`	`261`	`}`
`262`	`262`	`}`
`263`		`- RichText(linkClickHandler = { toggleLink = !toggleLink }) {`
	`263`	`+ RichText {`
`264`	`264`	`Text(text)`
`265`	`265`	`}`
`266`	`266`	`}`