Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate to the new LinkAnnotation APIs #64

Merged
merged 2 commits into from
Dec 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/code-scanning.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ jobs:
- name: Setup Java JDK
uses: actions/setup-java@v4
with:
java-version: 17
java-version: 21
distribution: temurin
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v3
uses: gradle/actions/setup-gradle@v4
- name: Run Detekt & Lint
continue-on-error: true
run: ./gradlew detektMetadataMain lint --continue
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/pr-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ jobs:
- name: Setup Java JDK
uses: actions/setup-java@v4
with:
java-version: 17
java-version: 21
distribution: temurin
- name: Setup Gradle
uses: gradle/gradle-build-action@v3
uses: gradle/actions/setup-gradle@v4
- name: Build
run: ./gradlew assemble${{ matrix.variant }} --scan
test:
Expand All @@ -33,9 +33,9 @@ jobs:
- name: Setup Java JDK
uses: actions/setup-java@v4
with:
java-version: 17
java-version: 21
distribution: temurin
- name: Setup Gradle
uses: gradle/gradle-build-action@v3
uses: gradle/actions/setup-gradle@v4
- name: Test
run: ./gradlew test${{ matrix.variant }}UnitTest --scan
12 changes: 6 additions & 6 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ jobs:
- name: Setup Java JDK
uses: actions/setup-java@v4
with:
java-version: 17
java-version: 21
distribution: temurin
- name: Setup Gradle
uses: gradle/gradle-build-action@v3
uses: gradle/actions/setup-gradle@v4
- name: Build
run: ./gradlew publishAllPublicationsToGithubRepository --scan
env:
Expand All @@ -41,10 +41,10 @@ jobs:
- name: Setup Java JDK
uses: actions/setup-java@v4
with:
java-version: 17
java-version: 21
distribution: temurin
- name: Setup Gradle
uses: gradle/gradle-build-action@v3
uses: gradle/actions/setup-gradle@v4
- name: Build
run: ./gradlew publishAllPublicationsToOssRepository --scan -Dorg.gradle.parallel=false
env:
Expand All @@ -67,10 +67,10 @@ jobs:
- name: Setup Java JDK
uses: actions/setup-java@v4
with:
java-version: 17
java-version: 21
distribution: temurin
- name: Setup Gradle
uses: gradle/gradle-build-action@v3
uses: gradle/actions/setup-gradle@v4
- name: Build
run: ./gradlew dokkaHtmlMultiModule
- name: Upload Pages Artifact
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import androidx.compose.runtime.Composable
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.platform.LocalDensity
import androidx.compose.ui.text.LinkAnnotation
import androidx.compose.ui.text.font.FontFamily
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.TextUnit
Expand Down Expand Up @@ -50,7 +51,7 @@ public fun MarkdownDocument(
codeBlockStyle: CodeBlockStyle,
ruleStyle: RuleStyle,
tableStyle: TableStyle,
onLinkClick: (String) -> Unit,
onLinkClick: (LinkAnnotation) -> Unit,
modifier: Modifier = Modifier,
sectionSpacing: Dp = textStyles.textStyle.fontSize.toDp()
) {
Expand Down Expand Up @@ -94,7 +95,7 @@ internal fun MarkdownNode(
codeBlockStyle: CodeBlockStyle,
ruleStyle: RuleStyle,
tableStyle: TableStyle,
onLinkClick: (String) -> Unit,
onLinkClick: (LinkAnnotation) -> Unit,
modifier: Modifier = Modifier
) {
when (node) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import androidx.compose.foundation.layout.width
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.text.LinkAnnotation
import com.boswelja.markdown.MarkdownNode
import com.boswelja.markdown.generator.MarkdownBlockQuote
import com.boswelja.markdown.style.BlockQuoteStyle
Expand All @@ -35,7 +36,7 @@ internal fun MarkdownBlockQuote(
codeBlockStyle: CodeBlockStyle,
ruleStyle: RuleStyle,
tableStyle: TableStyle,
onLinkClick: (String) -> Unit,
onLinkClick: (LinkAnnotation) -> Unit,
modifier: Modifier = Modifier,
) {
Box(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import androidx.compose.foundation.text.BasicText
import androidx.compose.runtime.Composable
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.text.LinkAnnotation
import androidx.compose.ui.unit.dp
import com.boswelja.markdown.MarkdownNode
import com.boswelja.markdown.generator.MarkdownOrderedList
Expand All @@ -33,7 +34,7 @@ internal fun MarkdownOrderedList(
codeBlockStyle: CodeBlockStyle,
ruleStyle: RuleStyle,
tableStyle: TableStyle,
onLinkClick: (String) -> Unit,
onLinkClick: (LinkAnnotation) -> Unit,
modifier: Modifier = Modifier,
) {
Column(modifier) {
Expand Down Expand Up @@ -78,7 +79,7 @@ internal fun MarkdownUnorderedList(
codeBlockStyle: CodeBlockStyle,
ruleStyle: RuleStyle,
tableStyle: TableStyle,
onLinkClick: (String) -> Unit,
onLinkClick: (LinkAnnotation) -> Unit,
modifier: Modifier = Modifier,
) {
Column(modifier) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.input.pointer.pointerInput
import androidx.compose.ui.text.ExperimentalTextApi
import androidx.compose.ui.text.LinkAnnotation
import androidx.compose.ui.text.TextLayoutResult
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.unit.sp
Expand All @@ -19,13 +19,12 @@ import com.boswelja.markdown.style.TextUnitSize
* Displays a [MarkdownParagraph]. A paragraph is a group of "spans". Spans are stylized sections of
* text, but can also include inline images and links.
*/
@OptIn(ExperimentalTextApi::class)
@Composable
internal fun MarkdownParagraph(
paragraph: MarkdownParagraph,
textStyle: TextStyle,
textStyleModifiers: TextStyleModifiers,
onLinkClick: (String) -> Unit,
onLinkClick: (LinkAnnotation) -> Unit,
modifier: Modifier = Modifier,
) {
val (annotatedString, inlineContent) = remember(paragraph) {
Expand All @@ -36,9 +35,11 @@ internal fun MarkdownParagraph(
detectTapGestures { pos ->
layoutResult.value?.let { layoutResult ->
val offset = layoutResult.getOffsetForPosition(pos)
annotatedString.getUrlAnnotations(start = offset, end = offset).firstOrNull()?.let { annotation ->
onLinkClick(annotation.item.url)
}
annotatedString.getLinkAnnotations(start = offset, end = offset)
.firstOrNull()
?.let { annotation ->
annotation.item.linkInteractionListener?.onClick(annotation.item)
}
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,12 @@ import androidx.compose.foundation.text.InlineTextContent
import androidx.compose.foundation.text.appendInlineContent
import androidx.compose.ui.Modifier
import androidx.compose.ui.text.AnnotatedString
import androidx.compose.ui.text.ExperimentalTextApi
import androidx.compose.ui.text.LinkAnnotation
import androidx.compose.ui.text.Placeholder
import androidx.compose.ui.text.PlaceholderVerticalAlign
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.text.UrlAnnotation
import androidx.compose.ui.text.buildAnnotatedString
import androidx.compose.ui.text.withAnnotation
import androidx.compose.ui.text.withLink
import androidx.compose.ui.text.withStyle
import coil3.compose.AsyncImage
import coil3.compose.LocalPlatformContext
Expand Down Expand Up @@ -73,7 +72,6 @@ internal data class TextWithContent(
val content: Map<String, InlineTextContent>
)

@OptIn(ExperimentalTextApi::class)
internal fun MarkdownSpanNode.toAnnotatedString(
textStyle: TextStyle,
textStyleModifiers: TextStyleModifiers,
Expand All @@ -87,7 +85,7 @@ internal fun MarkdownSpanNode.toAnnotatedString(
appendInlineContent(imageUrl, contentDescription)
}
is MarkdownLink -> buildAnnotatedString {
withAnnotation(UrlAnnotation(url)) {
withLink(LinkAnnotation.Url(url)) {
withStyle(textStyleModifiers.link(textStyle).toSpanStyle()) {
displayText.forEach {
append(it.toAnnotatedString(textStyle, textStyleModifiers))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.compose.ui.text.LinkAnnotation
import androidx.compose.ui.text.TextStyle
import com.boswelja.markdown.generator.MarkdownTable
import com.boswelja.markdown.style.RuleStyle
Expand All @@ -22,7 +23,7 @@ internal fun MarkdownTable(
textStyle: TextStyle,
textStyleModifiers: TextStyleModifiers,
ruleStyle: RuleStyle,
onLinkClick: (String) -> Unit,
onLinkClick: (LinkAnnotation) -> Unit,
modifier: Modifier = Modifier,
) {
Column(modifier) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,4 @@
package com.nasdroid.core.markdown

import com.boswelja.markdown.generator.MarkdownBlockQuote
import com.boswelja.markdown.generator.MarkdownCodeBlock
import com.boswelja.markdown.generator.MarkdownCodeSpan
import com.boswelja.markdown.generator.MarkdownHeading
import com.boswelja.markdown.generator.MarkdownImage
import com.boswelja.markdown.generator.MarkdownLink
import com.boswelja.markdown.generator.MarkdownListItem
import com.boswelja.markdown.generator.MarkdownNode
import com.boswelja.markdown.generator.MarkdownOrderedList
import com.boswelja.markdown.generator.MarkdownParagraph
import com.boswelja.markdown.generator.MarkdownSpanNode
import com.boswelja.markdown.generator.MarkdownTable
import com.boswelja.markdown.generator.MarkdownText
import com.boswelja.markdown.generator.MarkdownUnorderedList
package com.boswelja.markdown.generator

internal object MarkdownNodeBuilders {
fun markdownUnorderedList(vararg listItems: MarkdownListItem): MarkdownUnorderedList {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,28 +1,18 @@
package com.nasdroid.core.markdown

import com.boswelja.markdown.generator.MarkdownEol
import com.boswelja.markdown.generator.MarkdownHeading
import com.boswelja.markdown.generator.MarkdownNode
import com.boswelja.markdown.generator.MarkdownNodeGenerator
import com.boswelja.markdown.generator.MarkdownParagraph
import com.boswelja.markdown.generator.MarkdownRule
import com.boswelja.markdown.generator.MarkdownSpanNode
import com.boswelja.markdown.generator.MarkdownTable
import com.boswelja.markdown.generator.MarkdownWhitespace
import com.boswelja.markdown.generator.TestMarkdown
import com.nasdroid.core.markdown.MarkdownNodeBuilders.markdownBlockQuote
import com.nasdroid.core.markdown.MarkdownNodeBuilders.markdownCodeBlock
import com.nasdroid.core.markdown.MarkdownNodeBuilders.markdownCodeSpan
import com.nasdroid.core.markdown.MarkdownNodeBuilders.markdownHeader
import com.nasdroid.core.markdown.MarkdownNodeBuilders.markdownImage
import com.nasdroid.core.markdown.MarkdownNodeBuilders.markdownLink
import com.nasdroid.core.markdown.MarkdownNodeBuilders.markdownListItem
import com.nasdroid.core.markdown.MarkdownNodeBuilders.markdownOrderedList
import com.nasdroid.core.markdown.MarkdownNodeBuilders.markdownParagraph
import com.nasdroid.core.markdown.MarkdownNodeBuilders.markdownTable
import com.nasdroid.core.markdown.MarkdownNodeBuilders.markdownTableColumn
import com.nasdroid.core.markdown.MarkdownNodeBuilders.markdownText
import com.nasdroid.core.markdown.MarkdownNodeBuilders.markdownUnorderedList
package com.boswelja.markdown.generator

import com.boswelja.markdown.generator.MarkdownNodeBuilders.markdownBlockQuote
import com.boswelja.markdown.generator.MarkdownNodeBuilders.markdownCodeBlock
import com.boswelja.markdown.generator.MarkdownNodeBuilders.markdownCodeSpan
import com.boswelja.markdown.generator.MarkdownNodeBuilders.markdownHeader
import com.boswelja.markdown.generator.MarkdownNodeBuilders.markdownImage
import com.boswelja.markdown.generator.MarkdownNodeBuilders.markdownLink
import com.boswelja.markdown.generator.MarkdownNodeBuilders.markdownListItem
import com.boswelja.markdown.generator.MarkdownNodeBuilders.markdownOrderedList
import com.boswelja.markdown.generator.MarkdownNodeBuilders.markdownParagraph
import com.boswelja.markdown.generator.MarkdownNodeBuilders.markdownTable
import com.boswelja.markdown.generator.MarkdownNodeBuilders.markdownTableColumn
import com.boswelja.markdown.generator.MarkdownNodeBuilders.markdownText
import com.boswelja.markdown.generator.MarkdownNodeBuilders.markdownUnorderedList
import org.intellij.markdown.ast.ASTNode
import org.intellij.markdown.flavours.gfm.GFMFlavourDescriptor
import org.intellij.markdown.parser.MarkdownParser
Expand Down
1 change: 1 addition & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ kotlin.code.style=official

# Dokka 2
org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
org.jetbrains.dokka.experimental.tryK2=true

# Below here is all packaging details, not build configuration.
version=1.1.0
Expand Down
6 changes: 3 additions & 3 deletions gradle/libs.versions.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[versions]
android-gradle-plugin = "8.7.2"
android-gradle-plugin = "8.7.3"
detekt = "1.23.7"
kotlin = "2.1.0"
dokka = "2.0.0-Beta"
dokka = "2.0.0"

compose = "1.7.1"
compose = "1.7.3"

coil = "3.0.4"

Expand Down
Binary file modified gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
2 changes: 1 addition & 1 deletion gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.11-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
Expand Down
7 changes: 5 additions & 2 deletions gradlew
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
#

##############################################################################
#
Expand Down Expand Up @@ -55,7 +57,7 @@
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
Expand Down Expand Up @@ -84,7 +86,8 @@ done
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
' "$PWD" ) || exit

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
Expand Down
2 changes: 2 additions & 0 deletions gradlew.bat
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@rem SPDX-License-Identifier: Apache-2.0
@rem

@if "%DEBUG%"=="" @echo off
@rem ##########################################################################
Expand Down
Loading
Loading