├── .github └── workflows │ ├── build.yml │ └── release.yml ├── .gitignore ├── LICENSE ├── README.md ├── build.gradle.kts ├── buildSrc ├── .gitignore ├── build.gradle.kts ├── settings.gradle.kts └── src │ └── main │ └── kotlin │ └── Setup.kt ├── demo ├── .gitignore ├── build.gradle.kts ├── proguard-rules.pro ├── release │ └── output-metadata.json └── src │ ├── androidTest │ └── java │ │ └── xyz │ │ └── wingio │ │ └── syntakts │ │ └── demo │ │ └── ExampleInstrumentedTest.kt │ └── main │ ├── AndroidManifest.xml │ ├── java │ └── xyz │ │ └── wingio │ │ └── syntakts │ │ └── demo │ │ ├── AndroidTestActivity.kt │ │ ├── MainActivity.kt │ │ ├── TestSyntakts.kt │ │ └── ui │ │ └── theme │ │ ├── Color.kt │ │ ├── Theme.kt │ │ └── Type.kt │ └── res │ ├── drawable-v24 │ └── ic_launcher_foreground.xml │ ├── drawable │ └── ic_launcher_background.xml │ ├── font │ └── jetbrains_mono.ttf │ ├── layout │ └── activity_android_test.xml │ ├── mipmap-anydpi-v26 │ ├── ic_launcher.xml │ └── ic_launcher_round.xml │ ├── mipmap-hdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-mdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-xhdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-xxhdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-xxxhdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── values │ ├── colors.xml │ ├── strings.xml │ └── themes.xml │ └── xml │ ├── backup_rules.xml │ └── data_extraction_rules.xml ├── gradle.properties ├── gradle ├── libs.versions.toml └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── images └── logo.png ├── settings.gradle.kts ├── syntakts-android ├── .gitignore ├── api │ └── syntakts-android.api ├── build.gradle.kts └── src │ └── main │ └── kotlin │ └── xyz │ └── wingio │ └── syntakts │ └── android │ ├── ClickableMovementMethod.kt │ ├── Syntakts.kt │ ├── markdown │ └── Markdown.kt │ ├── spans │ ├── AnnotationSpan.kt │ ├── ClickableSpan.kt │ └── SyntaktsStyleSpan.kt │ ├── style │ ├── AndroidFontResolver.kt │ ├── Color.kt │ └── SpannableStyledTextBuilder.kt │ └── util │ └── DimenUtil.kt ├── syntakts-compose-material3 ├── .gitignore ├── api │ ├── android │ │ └── syntakts-compose-material3.api │ └── jvm │ │ └── syntakts-compose-material3.api ├── build.gradle.kts └── src │ └── commonMain │ └── kotlin │ └── xyz │ └── wingio │ └── syntakts │ └── compose │ └── material3 │ └── clickable │ └── ClickableText.kt ├── syntakts-compose ├── .gitignore ├── api │ ├── android │ │ └── syntakts-compose.api │ └── jvm │ │ └── syntakts-compose.api ├── build.gradle.kts └── src │ └── commonMain │ └── kotlin │ └── xyz │ └── wingio │ └── syntakts │ └── compose │ ├── Syntakts.kt │ ├── clickable │ ├── ClickHandlerStore.kt │ └── ClickableText.kt │ └── style │ ├── AnnotatedStyledTextBuilder.kt │ ├── Color.kt │ ├── ComposeFontResolver.kt │ ├── FontStyle.kt │ ├── FontWeight.kt │ ├── TextDecoration.kt │ └── TextUnit.kt └── syntakts-core ├── .gitignore ├── api ├── android │ └── syntakts-core.api └── jvm │ └── syntakts-core.api ├── build.gradle.kts └── src ├── androidMain └── kotlin │ └── xyz │ └── wingio │ └── syntakts │ └── util │ └── Logger.android.kt ├── commonMain └── kotlin │ └── xyz │ └── wingio │ └── syntakts │ ├── ParseException.kt │ ├── Syntakts.kt │ ├── markdown │ └── Markdown.kt │ ├── node │ ├── ClickableNode.kt │ ├── Node.kt │ ├── NodeDsl.kt │ ├── StyleNode.kt │ └── TextNode.kt │ ├── parser │ ├── ParseSpec.kt │ └── Rule.kt │ ├── style │ ├── Color.kt │ ├── FontResolver.kt │ ├── FontStyle.kt │ ├── FontWeight.kt │ ├── Style.kt │ ├── StyledTextBuilder.kt │ ├── TextDecoration.kt │ └── TextUnit.kt │ └── util │ ├── Logger.kt │ ├── MarkdownUtils.kt │ ├── Stack.kt │ ├── SynchronizedCache.kt │ └── Utils.kt ├── commonTest └── kotlin │ └── SyntaktsTest.kt └── jvmMain └── kotlin └── xyz └── wingio └── syntakts └── util └── Logger.jvm.kt /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build artifacts 2 | 3 | on: 4 | push: 5 | branches: 6 | - '*' 7 | paths-ignore: 8 | - '**.md' 9 | - '.idea/*' 10 | - 'LICENSE' 11 | pull_request: 12 | branches: 13 | - '*' 14 | paths-ignore: 15 | - '**.md' 16 | - '.idea/*' 17 | - 'LICENSE' 18 | workflow_dispatch: 19 | 20 | jobs: 21 | build: 22 | timeout-minutes: 60 23 | runs-on: ubuntu-latest 24 | steps: 25 | - uses: actions/checkout@v2 26 | 27 | - name: Setup JDK 17 28 | uses: actions/setup-java@v2 29 | with: 30 | java-version: 17 31 | distribution: 'temurin' 32 | cache: 'gradle' 33 | 34 | - name: Setup Android SDK 35 | uses: android-actions/setup-android@v2.0.10 36 | 37 | - name: Setup Gradle 38 | uses: gradle/gradle-build-action@v2.4.2 39 | 40 | - name: Build artifacts 41 | run: | 42 | chmod +x gradlew 43 | ./gradlew publishToMavenLocal --no-daemon --stacktrace 44 | 45 | - name: Upload artifacts 46 | uses: actions/upload-artifact@v3 47 | with: 48 | name: artifacts 49 | path: ~/.m2/repository/ -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | 3 | concurrency: 4 | group: "release" 5 | cancel-in-progress: true 6 | 7 | permissions: 8 | contents: write 9 | 10 | on: 11 | workflow_dispatch: 12 | inputs: 13 | version: 14 | required: true 15 | description: Release version 16 | default: "1.0.0" 17 | 18 | jobs: 19 | release: 20 | timeout-minutes: 60 21 | runs-on: ubuntu-latest 22 | steps: 23 | - uses: actions/checkout@v2 24 | 25 | - name: Test version 26 | id: version 27 | run: | 28 | version=${{github.event.inputs.version}} 29 | if git show-ref --tags --quiet --verify -- "refs/tags/$version" >/dev/null; then 30 | echo "Git tag $version already exists, failing to publish"; 31 | exit 1 32 | else 33 | echo "::set-output name=release_tag::$version" 34 | fi 35 | 36 | - name: Setup JDK 17 37 | uses: actions/setup-java@v2 38 | with: 39 | java-version: 17 40 | distribution: 'temurin' 41 | cache: 'gradle' 42 | 43 | - name: Setup Android SDK 44 | uses: android-actions/setup-android@v2.0.10 45 | 46 | - name: Setup Gradle 47 | uses: gradle/gradle-build-action@v2.4.2 48 | 49 | - name: Build and Maven publish 50 | env: 51 | ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }} 52 | ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }} 53 | ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_IN_MEMORY_KEY }} 54 | ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_IN_MEMORY_KEY_PASSWORD }} 55 | LIBRARY_VERSION: ${{ github.event.inputs.version }} 56 | run: | 57 | chmod +x gradlew 58 | ./gradlew publishAllPublicationsToMavenCentral --no-configuration-cache --no-daemon --stacktrace 59 | 60 | - name: Create Release 61 | uses: softprops/action-gh-release@v1 62 | with: 63 | tag_name: ${{ steps.version.outputs.release_tag }} 64 | generate_release_notes: true -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Gradle files 2 | .gradle/ 3 | build/ 4 | 5 | # Local configuration file (sdk path, etc) 6 | local.properties 7 | 8 | # Log/OS Files 9 | *.log 10 | 11 | # Android Studio generated files and folders 12 | captures/ 13 | .externalNativeBuild/ 14 | .cxx/ 15 | *.apk 16 | output.json 17 | 18 | # IntelliJ 19 | *.iml 20 | .idea/ 21 | misc.xml 22 | deploymentTargetDropDown.xml 23 | render.experimental.xml 24 | 25 | # Keystore files 26 | *.jks 27 | *.keystore 28 | 29 | # Google Services (e.g. APIs or Firebase) 30 | google-services.json 31 | 32 | # Android Profiling 33 | *.hprof 34 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Wing 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | Syntakts 3 | 4 | ### Simple to use text parser and syntax highlighter for Kotlin Multiplatform 5 | [![Maven Central](https://img.shields.io/maven-central/v/xyz.wingio.syntakts/syntakts-core?style=for-the-badge&logo=apachemaven&label=Latest&labelColor=black&color=blue)](https://central.sonatype.com/namespace/xyz.wingio.syntakts) 6 | [![GitHub Repo stars](https://img.shields.io/github/stars/wingio/syntakts?style=for-the-badge&logo=github&labelColor=black&color=red)](https://github.com/wingio/syntakts/stargazers) 7 | [![GitHub Sponsors](https://img.shields.io/github/sponsors/wingio?style=for-the-badge&logo=githubsponsors&labelColor=black&color=pink)](https://github.com/sponsors/wingio) 8 | 9 | --- 10 |
11 | 12 | ## Setup 13 | ```kotlin 14 | implementation("xyz.wingio.syntakts:syntakts-core:$syntaktsVersion") 15 | // implementation("xyz.wingio.syntakts:syntakts-compose:$syntaktsVersion") 16 | // implementation("xyz.wingio.syntakts:syntakts-compose-material3:$syntaktsVersion") 17 | ``` 18 | 19 | ## Use 20 | Syntakts can be set up through a simple DSL: 21 | ```kotlin 22 | val mySyntakts = syntakts { 23 | rule("@([A-z])") { result, context -> 24 | append(result.groupValues[1]) { 25 | color = Color.Yellow 26 | } 27 | } 28 | } 29 | ``` 30 | 31 | We also provide MarkdownSyntakts and BasicMarkdownSyntakts, which has some default markdown rules 32 | 33 | ### Context 34 | Syntakts allows you to pass any class as context, this can be used to pass additional information for rendering. 35 | If you don't need to use context you can set it to Unit 36 | 37 | Example: 38 | ```kotlin 39 | data class Context( 40 | val userMap = mapOf("1234" to "Wing") 41 | ) 42 | 43 | val mySytankts = syntakts { 44 | rule("<@([0-9]+)>") { result, context -> 45 | val username = context.userMap[result.groupValues[1]] ?: "Unknown" 46 | append("@$username") { 47 | color = Color.Yellow 48 | } 49 | } 50 | } 51 | ``` 52 | 53 | ## Displaying 54 | 55 | ### Compose 56 | Artifact: `syntakts-compose` 57 | 58 | Syntakts uses AnnotatedStrings in order to display rendered text in Compose 59 | 60 | > [!NOTE] 61 | > 62 | > When creating a Syntakts instance in a composable we reccommend replacing `syntakts {}` with `rememberSyntakts {}` 63 | 64 | Example: 65 | ```kotlin 66 | @Composable 67 | fun SomeScreen() { 68 | val syntakts = rememberSyntakts { /* */ } 69 | 70 | Text( 71 | text = syntakts.rememberRendered("some input") 72 | ) 73 | } 74 | ``` 75 | 76 | ### Android 77 | Artifact: `syntakts-android` 78 | 79 | Syntakts uses SpannableStrings in order to display rendered text on Android 80 | 81 | Example: 82 | ```kotlin 83 | val syntakts = syntakts { /* */ } 84 | 85 | findViewById(R.id.my_text_view).render("some input", syntakts) 86 | ``` 87 | 88 | #### Clickable 89 | Syntakts for Compose includes a ClickableText component that is neccessary in order to handle clickable text. The `syntakts-compose-material3` includes this component as well but adds support for Material 3 theming 90 | 91 | Syntakts for Android requires that the TextView have its movementMethod set to our ClickableMovementMethod 92 | 93 | ## Attribution 94 | Syntakts was heavily inspired by [SimpleAST](https://github.com/discord/SimpleAST), an unfortunately abandoned library that was once used in Discords android app 95 | -------------------------------------------------------------------------------- /build.gradle.kts: -------------------------------------------------------------------------------- 1 | buildscript { 2 | repositories { 3 | mavenCentral() 4 | google() 5 | gradlePluginPortal() 6 | maven(url = "https://maven.pkg.jetbrains.space/public/p/compose/dev" ) 7 | } 8 | 9 | dependencies { 10 | classpath(libs.plugin.maven) 11 | classpath(libs.plugin.multiplatform.compose) 12 | classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:2.0.0") 13 | } 14 | } 15 | 16 | allprojects { 17 | group = "xyz.wingio.syntakts" 18 | version = "1.0.0-SNAPSHOT" 19 | } -------------------------------------------------------------------------------- /buildSrc/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | /.gradle -------------------------------------------------------------------------------- /buildSrc/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | `kotlin-dsl` 3 | } 4 | 5 | repositories { 6 | google() 7 | mavenCentral() 8 | gradlePluginPortal() 9 | } 10 | 11 | dependencies { 12 | implementation(libs.plugin.android) 13 | implementation(libs.plugin.kotlin) 14 | implementation(libs.plugin.maven) 15 | } -------------------------------------------------------------------------------- /buildSrc/settings.gradle.kts: -------------------------------------------------------------------------------- 1 | dependencyResolutionManagement { 2 | versionCatalogs { 3 | create("libs") { 4 | from(files("../gradle/libs.versions.toml")) 5 | } 6 | } 7 | } -------------------------------------------------------------------------------- /buildSrc/src/main/kotlin/Setup.kt: -------------------------------------------------------------------------------- 1 | import com.android.build.gradle.BaseExtension 2 | import com.android.build.gradle.LibraryExtension 3 | import com.vanniktech.maven.publish.AndroidSingleVariantLibrary 4 | import com.vanniktech.maven.publish.JavaLibrary 5 | import com.vanniktech.maven.publish.JavadocJar 6 | import com.vanniktech.maven.publish.KotlinMultiplatform 7 | import org.gradle.api.Project 8 | import org.gradle.kotlin.dsl.findByType 9 | import org.gradle.api.provider.Property 10 | import org.gradle.kotlin.dsl.task 11 | import com.vanniktech.maven.publish.MavenPublishBaseExtension 12 | import com.vanniktech.maven.publish.Platform 13 | import com.vanniktech.maven.publish.SonatypeHost 14 | import org.gradle.jvm.tasks.Jar 15 | 16 | // Lets us use `=` for assignments 17 | private fun Property.assign(value: T) = set(value) 18 | 19 | fun Project.setupAndroid(name: String) { 20 | val androidExtension: LibraryExtension = extensions.findByType() 21 | ?: error("Could not found Android library plugin applied on module $name") 22 | 23 | androidExtension.apply { 24 | namespace = "xyz.wingio.${name.replace("-", ".")}" 25 | compileSdk = 34 26 | defaultConfig { 27 | minSdk = 21 28 | } 29 | } 30 | } 31 | 32 | @Suppress("UnstableApiUsage") 33 | fun Project.setup( 34 | libName: String, 35 | moduleName: String, 36 | moduleDescription: String, 37 | androidOnly: Boolean = false 38 | ) { 39 | setupAndroid(moduleName) 40 | 41 | val mavenPublishing = extensions.findByType() ?: error("Couldn't find maven publish plugin") 42 | 43 | mavenPublishing.apply { 44 | if(androidOnly) { 45 | configure(AndroidSingleVariantLibrary("release")) 46 | } else { 47 | configure(KotlinMultiplatform(JavadocJar.Empty())) 48 | } 49 | publishToMavenCentral(SonatypeHost.S01, automaticRelease = true) 50 | signAllPublications() 51 | 52 | coordinates("xyz.wingio.syntakts", moduleName, System.getenv("LIBRARY_VERSION") ?: version.toString()) 53 | 54 | pom { 55 | name = libName 56 | description = moduleDescription 57 | inceptionYear = "2023" 58 | url = "https://github.com/wingio/syntakts" 59 | 60 | licenses { 61 | license { 62 | name = "MIT License" 63 | url = "https://opensource.org/license/mit/" 64 | } 65 | } 66 | developers { 67 | developer { 68 | id = "wingio" 69 | name = "Wing" 70 | url = "https://wingio.xyz" 71 | } 72 | } 73 | scm { 74 | url = "https://github.com/wingio/syntakts" 75 | connection = "scm:git:github.com/wingio/syntakts.git" 76 | developerConnection = "scm:git:ssh://github.com/wingio/syntakts.git" 77 | } 78 | } 79 | } 80 | } -------------------------------------------------------------------------------- /demo/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /demo/build.gradle.kts: -------------------------------------------------------------------------------- 1 | @Suppress("DSL_SCOPE_VIOLATION") // TODO: Remove once KTIJ-19369 is fixed 2 | plugins { 3 | kotlin("android") 4 | id("com.android.application") 5 | alias(libs.plugins.compose.compiler) 6 | } 7 | 8 | android { 9 | namespace = "xyz.wingio.syntakts.demo" 10 | compileSdk = 34 11 | 12 | defaultConfig { 13 | applicationId = "xyz.wingio.syntakts.demo" 14 | minSdk = 21 15 | targetSdk = 34 16 | versionCode = 1 17 | versionName = "1.0" 18 | 19 | testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" 20 | vectorDrawables { 21 | useSupportLibrary = true 22 | } 23 | } 24 | 25 | buildTypes { 26 | release { 27 | isMinifyEnabled = false 28 | proguardFiles( 29 | getDefaultProguardFile("proguard-android-optimize.txt"), 30 | "proguard-rules.pro" 31 | ) 32 | } 33 | } 34 | compileOptions { 35 | sourceCompatibility = JavaVersion.VERSION_1_8 36 | targetCompatibility = JavaVersion.VERSION_1_8 37 | } 38 | kotlinOptions { 39 | jvmTarget = "1.8" 40 | } 41 | buildFeatures { 42 | compose = true 43 | } 44 | packaging { 45 | resources { 46 | excludes += "/META-INF/{AL2.0,LGPL2.1}" 47 | } 48 | } 49 | } 50 | 51 | dependencies { 52 | implementation(libs.bundles.compose) 53 | implementation(project(":syntakts-compose-material3")) 54 | implementation(project(":syntakts-android")) 55 | implementation(libs.appcompat) 56 | implementation(libs.material) 57 | implementation(libs.constraintlayout) 58 | } -------------------------------------------------------------------------------- /demo/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /demo/release/output-metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": 3, 3 | "artifactType": { 4 | "type": "APK", 5 | "kind": "Directory" 6 | }, 7 | "applicationId": "xyz.wingio.syntakts.demo", 8 | "variantName": "release", 9 | "elements": [ 10 | { 11 | "type": "SINGLE", 12 | "filters": [], 13 | "attributes": [], 14 | "versionCode": 1, 15 | "versionName": "1.0", 16 | "outputFile": "demo-release.apk" 17 | } 18 | ], 19 | "elementType": "File" 20 | } -------------------------------------------------------------------------------- /demo/src/androidTest/java/xyz/wingio/syntakts/demo/ExampleInstrumentedTest.kt: -------------------------------------------------------------------------------- 1 | package xyz.wingio.syntakts.demo 2 | 3 | import androidx.test.platform.app.InstrumentationRegistry 4 | import androidx.test.ext.junit.runners.AndroidJUnit4 5 | 6 | import org.junit.Test 7 | import org.junit.runner.RunWith 8 | 9 | import org.junit.Assert.* 10 | 11 | /** 12 | * Instrumented test, which will execute on an Android device. 13 | * 14 | * See [testing documentation](http://d.android.com/tools/testing). 15 | */ 16 | @RunWith(AndroidJUnit4::class) 17 | class ExampleInstrumentedTest { 18 | @Test 19 | fun useAppContext() { 20 | // Context of the app under test. 21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext 22 | assertEquals("xyz.wingio.syntakts.demo", appContext.packageName) 23 | } 24 | } -------------------------------------------------------------------------------- /demo/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 15 | 19 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /demo/src/main/java/xyz/wingio/syntakts/demo/AndroidTestActivity.kt: -------------------------------------------------------------------------------- 1 | package xyz.wingio.syntakts.demo 2 | 3 | import android.os.Bundle 4 | import android.widget.TextView 5 | import androidx.activity.ComponentActivity 6 | import androidx.core.content.res.ResourcesCompat 7 | import xyz.wingio.syntakts.android.render 8 | import xyz.wingio.syntakts.android.style.DefaultFontResolver 9 | 10 | class AndroidTestActivity : ComponentActivity() { 11 | 12 | override fun onCreate(savedInstanceState: Bundle?) { 13 | super.onCreate(savedInstanceState) 14 | setContentView(R.layout.activity_android_test) 15 | 16 | DefaultFontResolver.register( 17 | "jetbrains mono" to ResourcesCompat.getFont(this, R.font.jetbrains_mono)!! 18 | ) 19 | 20 | val testString = """ 21 | # Header 22 | **Bold** *Italic* __Underline__ ~~Strikethrough~~ <@1234> :heart: 23 | `println("hi")` 24 | """.trimIndent() 25 | 26 | findViewById(R.id.test_text).render( 27 | text = testString, 28 | syntakts = TestSyntakts, 29 | context = Context(this), 30 | enableClickable = true 31 | ) 32 | } 33 | 34 | } -------------------------------------------------------------------------------- /demo/src/main/java/xyz/wingio/syntakts/demo/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package xyz.wingio.syntakts.demo 2 | 3 | import android.content.Intent 4 | import android.os.Bundle 5 | import androidx.activity.ComponentActivity 6 | import androidx.activity.compose.setContent 7 | import androidx.compose.foundation.layout.Arrangement 8 | import androidx.compose.foundation.layout.Column 9 | import androidx.compose.foundation.layout.fillMaxSize 10 | import androidx.compose.foundation.layout.fillMaxWidth 11 | import androidx.compose.foundation.layout.padding 12 | import androidx.compose.foundation.rememberScrollState 13 | import androidx.compose.foundation.text.InlineTextContent 14 | import androidx.compose.foundation.verticalScroll 15 | import androidx.compose.material.icons.Icons 16 | import androidx.compose.material.icons.filled.Favorite 17 | import androidx.compose.material3.Button 18 | import androidx.compose.material3.Icon 19 | import androidx.compose.material3.LocalTextStyle 20 | import androidx.compose.material3.MaterialTheme 21 | import androidx.compose.material3.OutlinedTextField 22 | import androidx.compose.material3.Surface 23 | import androidx.compose.material3.Text 24 | import androidx.compose.runtime.getValue 25 | import androidx.compose.runtime.mutableStateOf 26 | import androidx.compose.runtime.remember 27 | import androidx.compose.runtime.setValue 28 | import androidx.compose.ui.Alignment 29 | import androidx.compose.ui.Modifier 30 | import androidx.compose.ui.platform.LocalContext 31 | import androidx.compose.ui.text.Placeholder 32 | import androidx.compose.ui.text.PlaceholderVerticalAlign 33 | import androidx.compose.ui.text.font.Font 34 | import androidx.compose.ui.text.font.FontFamily 35 | import androidx.compose.ui.unit.dp 36 | import xyz.wingio.syntakts.demo.ui.theme.SyntaktsTheme 37 | 38 | import xyz.wingio.syntakts.compose.material3.clickable.ClickableText 39 | import xyz.wingio.syntakts.compose.rememberRendered 40 | import xyz.wingio.syntakts.compose.style.DefaultFontResolver 41 | 42 | class MainActivity : ComponentActivity() { 43 | 44 | override fun onCreate(savedInstanceState: Bundle?) { 45 | super.onCreate(savedInstanceState) 46 | val atIntent = Intent(this, AndroidTestActivity::class.java) 47 | 48 | DefaultFontResolver.register( 49 | "jetbrains mono" to FontFamily(Font(R.font.jetbrains_mono)) 50 | ) 51 | 52 | setContent { 53 | SyntaktsTheme { 54 | var text by remember { mutableStateOf("**bold** *italic* __underline__ ~~strikethrough~~ `code`") } 55 | 56 | // A surface container using the 'background' color from the theme 57 | Surface( 58 | modifier = Modifier.fillMaxSize(), 59 | color = MaterialTheme.colorScheme.background 60 | ) { 61 | Column( 62 | verticalArrangement = Arrangement.spacedBy(16.dp, Alignment.CenterVertically), 63 | horizontalAlignment = Alignment.CenterHorizontally, 64 | modifier = Modifier 65 | .padding(16.dp) 66 | .fillMaxSize() 67 | ) { 68 | ClickableText( 69 | text = TestSyntakts.rememberRendered(text, Context(LocalContext.current)), 70 | inlineContent = mapOf( 71 | "heart" to InlineTextContent( 72 | Placeholder(LocalTextStyle.current.fontSize, LocalTextStyle.current.fontSize, PlaceholderVerticalAlign.Center) 73 | ) { 74 | Icon( 75 | imageVector = Icons.Filled.Favorite, 76 | contentDescription = it 77 | ) 78 | } 79 | ), 80 | modifier = Modifier 81 | .weight(1f) 82 | .fillMaxWidth() 83 | .verticalScroll(rememberScrollState()) 84 | ) 85 | 86 | OutlinedTextField( 87 | value = text, 88 | onValueChange = { 89 | text = it 90 | }, 91 | modifier = Modifier.weight(1f).fillMaxWidth() 92 | ) 93 | Button( 94 | onClick = { startActivity(atIntent) } 95 | ) { 96 | Text("Launch android test") 97 | } 98 | } 99 | } 100 | } 101 | } 102 | } 103 | 104 | } 105 | 106 | -------------------------------------------------------------------------------- /demo/src/main/java/xyz/wingio/syntakts/demo/TestSyntakts.kt: -------------------------------------------------------------------------------- 1 | package xyz.wingio.syntakts.demo 2 | 3 | import android.content.Context as AndroidContext 4 | import android.widget.Toast 5 | import xyz.wingio.syntakts.compose.style.appendInlineContent 6 | import xyz.wingio.syntakts.markdown.addMarkdownRules 7 | import xyz.wingio.syntakts.style.Color 8 | import xyz.wingio.syntakts.style.Style 9 | import xyz.wingio.syntakts.syntakts 10 | 11 | val TestSyntakts = syntakts { 12 | 13 | rule("<@([0-9]+)>") { result, ctx -> 14 | val username = ctx.userMap[result.groupValues[1]] ?: "Unknown" 15 | appendClickable( 16 | "@$username", 17 | Style( 18 | color = Color.MAGENTA, 19 | background = Color.MAGENTA withOpacity 0.2f 20 | ), 21 | onLongClick = { 22 | Toast.makeText(ctx.androidContext, "Mention long clicked", Toast.LENGTH_SHORT).show() 23 | }, 24 | onClick = { 25 | Toast.makeText(ctx.androidContext, "Mention clicked", Toast.LENGTH_SHORT).show() 26 | } 27 | ) 28 | } 29 | 30 | rule(":heart:") { result, _ -> 31 | appendInlineContent( 32 | id = "heart", 33 | alternateText = result.value 34 | ) 35 | } 36 | 37 | rule("(`+)([\\s\\S]*?[^`])\\1(?!`)") { result, _ -> 38 | append(result.groupValues[2]) { 39 | font = "jetbrains mono" 40 | } 41 | } 42 | 43 | addMarkdownRules() 44 | } 45 | 46 | data class Context( 47 | val androidContext: AndroidContext, 48 | val userMap: Map = mapOf("1234" to "Wing") 49 | ) -------------------------------------------------------------------------------- /demo/src/main/java/xyz/wingio/syntakts/demo/ui/theme/Color.kt: -------------------------------------------------------------------------------- 1 | package xyz.wingio.syntakts.demo.ui.theme 2 | 3 | import androidx.compose.ui.graphics.Color 4 | 5 | val Purple80 = Color(0xFFD0BCFF) 6 | val PurpleGrey80 = Color(0xFFCCC2DC) 7 | val Pink80 = Color(0xFFEFB8C8) 8 | 9 | val Purple40 = Color(0xFF6650a4) 10 | val PurpleGrey40 = Color(0xFF625b71) 11 | val Pink40 = Color(0xFF7D5260) -------------------------------------------------------------------------------- /demo/src/main/java/xyz/wingio/syntakts/demo/ui/theme/Theme.kt: -------------------------------------------------------------------------------- 1 | package xyz.wingio.syntakts.demo.ui.theme 2 | 3 | import android.app.Activity 4 | import android.os.Build 5 | import androidx.compose.foundation.isSystemInDarkTheme 6 | import androidx.compose.material3.MaterialTheme 7 | import androidx.compose.material3.darkColorScheme 8 | import androidx.compose.material3.dynamicDarkColorScheme 9 | import androidx.compose.material3.dynamicLightColorScheme 10 | import androidx.compose.material3.lightColorScheme 11 | import androidx.compose.runtime.Composable 12 | import androidx.compose.runtime.SideEffect 13 | import androidx.compose.ui.graphics.toArgb 14 | import androidx.compose.ui.platform.LocalContext 15 | import androidx.compose.ui.platform.LocalView 16 | import androidx.core.view.WindowCompat 17 | 18 | private val DarkColorScheme = darkColorScheme( 19 | primary = Purple80, 20 | secondary = PurpleGrey80, 21 | tertiary = Pink80 22 | ) 23 | 24 | private val LightColorScheme = lightColorScheme( 25 | primary = Purple40, 26 | secondary = PurpleGrey40, 27 | tertiary = Pink40 28 | 29 | /* Other default colors to override 30 | background = Color(0xFFFFFBFE), 31 | surface = Color(0xFFFFFBFE), 32 | onPrimary = Color.White, 33 | onSecondary = Color.White, 34 | onTertiary = Color.White, 35 | onBackground = Color(0xFF1C1B1F), 36 | onSurface = Color(0xFF1C1B1F), 37 | */ 38 | ) 39 | 40 | @Composable 41 | fun SyntaktsTheme( 42 | darkTheme: Boolean = isSystemInDarkTheme(), 43 | // Dynamic color is available on Android 12+ 44 | dynamicColor: Boolean = true, 45 | content: @Composable () -> Unit 46 | ) { 47 | val colorScheme = when { 48 | dynamicColor && Build.VERSION.SDK_INT >= Build.VERSION_CODES.S -> { 49 | val context = LocalContext.current 50 | if (darkTheme) dynamicDarkColorScheme(context) else dynamicLightColorScheme(context) 51 | } 52 | 53 | darkTheme -> DarkColorScheme 54 | else -> LightColorScheme 55 | } 56 | val view = LocalView.current 57 | if (!view.isInEditMode) { 58 | SideEffect { 59 | val window = (view.context as Activity).window 60 | window.statusBarColor = colorScheme.primary.toArgb() 61 | WindowCompat.getInsetsController(window, view).isAppearanceLightStatusBars = darkTheme 62 | } 63 | } 64 | 65 | MaterialTheme( 66 | colorScheme = colorScheme, 67 | typography = Typography, 68 | content = content 69 | ) 70 | } -------------------------------------------------------------------------------- /demo/src/main/java/xyz/wingio/syntakts/demo/ui/theme/Type.kt: -------------------------------------------------------------------------------- 1 | package xyz.wingio.syntakts.demo.ui.theme 2 | 3 | import androidx.compose.material3.Typography 4 | import androidx.compose.ui.text.TextStyle 5 | import androidx.compose.ui.text.font.FontFamily 6 | import androidx.compose.ui.text.font.FontWeight 7 | import androidx.compose.ui.unit.sp 8 | 9 | // Set of Material typography styles to start with 10 | val Typography = Typography( 11 | bodyLarge = TextStyle( 12 | fontFamily = FontFamily.Default, 13 | fontWeight = FontWeight.Normal, 14 | fontSize = 16.sp, 15 | lineHeight = 24.sp, 16 | letterSpacing = 0.5.sp 17 | ) 18 | /* Other default text styles to override 19 | titleLarge = TextStyle( 20 | fontFamily = FontFamily.Default, 21 | fontWeight = FontWeight.Normal, 22 | fontSize = 22.sp, 23 | lineHeight = 28.sp, 24 | letterSpacing = 0.sp 25 | ), 26 | labelSmall = TextStyle( 27 | fontFamily = FontFamily.Default, 28 | fontWeight = FontWeight.Medium, 29 | fontSize = 11.sp, 30 | lineHeight = 16.sp, 31 | letterSpacing = 0.5.sp 32 | ) 33 | */ 34 | ) -------------------------------------------------------------------------------- /demo/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 15 | 18 | 21 | 22 | 23 | 24 | 30 | -------------------------------------------------------------------------------- /demo/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /demo/src/main/res/font/jetbrains_mono.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wingio/syntakts/d2efac8efe21b6b3967c043c07ec60c0e5f357ce/demo/src/main/res/font/jetbrains_mono.ttf -------------------------------------------------------------------------------- /demo/src/main/res/layout/activity_android_test.xml: -------------------------------------------------------------------------------- 1 | 2 | 8 | 9 | 19 | 20 | -------------------------------------------------------------------------------- /demo/src/main/res/mipmap-anydpi-v26/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /demo/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /demo/src/main/res/mipmap-hdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wingio/syntakts/d2efac8efe21b6b3967c043c07ec60c0e5f357ce/demo/src/main/res/mipmap-hdpi/ic_launcher.webp -------------------------------------------------------------------------------- /demo/src/main/res/mipmap-hdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wingio/syntakts/d2efac8efe21b6b3967c043c07ec60c0e5f357ce/demo/src/main/res/mipmap-hdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /demo/src/main/res/mipmap-mdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wingio/syntakts/d2efac8efe21b6b3967c043c07ec60c0e5f357ce/demo/src/main/res/mipmap-mdpi/ic_launcher.webp -------------------------------------------------------------------------------- /demo/src/main/res/mipmap-mdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wingio/syntakts/d2efac8efe21b6b3967c043c07ec60c0e5f357ce/demo/src/main/res/mipmap-mdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /demo/src/main/res/mipmap-xhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wingio/syntakts/d2efac8efe21b6b3967c043c07ec60c0e5f357ce/demo/src/main/res/mipmap-xhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /demo/src/main/res/mipmap-xhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wingio/syntakts/d2efac8efe21b6b3967c043c07ec60c0e5f357ce/demo/src/main/res/mipmap-xhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /demo/src/main/res/mipmap-xxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wingio/syntakts/d2efac8efe21b6b3967c043c07ec60c0e5f357ce/demo/src/main/res/mipmap-xxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /demo/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wingio/syntakts/d2efac8efe21b6b3967c043c07ec60c0e5f357ce/demo/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /demo/src/main/res/mipmap-xxxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wingio/syntakts/d2efac8efe21b6b3967c043c07ec60c0e5f357ce/demo/src/main/res/mipmap-xxxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /demo/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wingio/syntakts/d2efac8efe21b6b3967c043c07ec60c0e5f357ce/demo/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /demo/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #FFBB86FC 4 | #FF6200EE 5 | #FF3700B3 6 | #FF03DAC5 7 | #FF018786 8 | #FF000000 9 | #FFFFFFFF 10 | -------------------------------------------------------------------------------- /demo/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | Syntakts 3 | -------------------------------------------------------------------------------- /demo/src/main/res/values/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |