https://github.com/zeeshanali-k/typist-cmp

A Compose Multiplatform Typing Animation Library for Android, iOS, Desktop and Web
https://github.com/zeeshanali-k/typist-cmp

android android-app android-lib android-library android-sdk android-studio compose-multiplatform ios jetpack-compose kotlin kotlin-multiplatform library

Last synced: 6 days ago
JSON representation

A Compose Multiplatform Typing Animation Library for Android, iOS, Desktop and Web

• Host: GitHub
• URL: https://github.com/zeeshanali-k/typist-cmp
• Owner: zeeshanali-k
• License: apache-2.0
• Created: 2023-08-27T09:01:14.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-30T06:01:35.000Z (3 months ago)
• Last Synced: 2024-09-06T01:13:07.088Z (2 months ago)
• Topics: android, android-app, android-lib, android-library, android-sdk, android-studio, compose-multiplatform, ios, jetpack-compose, kotlin, kotlin-multiplatform, library
• Language: Kotlin
• Homepage:
• Size: 3.28 MB
• Stars: 32
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-kotlin-multiplatform - typist-cmp - A Highly Customisable Typing Animation Library for Compose Multiplatform (Android & iOS) (Libraries / GUI)

README

        
[![Maven Central](https://img.shields.io/maven-central/v/tech.dev-scion/typist-cmp.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22tech.dev-scion%22%20AND%20a:%22typist-cmp%22)

# Typist-CMP

A Compose Multiplatform Text Typing Animation Library for Android, iOS, Desktop and Web.

Visit this link to checkout Typist for Jetpack Compose.





Pass multiple strings and infinite repititions option




## Usage

Add this to your project level "build.gradle" or in newer versions of gradle in "settings.gradle" under repositories section:


 ```groovy

repositories {

   mavenCentral()

}

```

Add this to your shared module build.gradle file in commonMain under dependencies section:


```kotlin

api("tech.dev-scion:typist-cmp:TAG")

```

Replace TAG with library version


Add Typist Composable to your app and configure accordingly:


```kotlin

Typist(

    text = "Hi! I am Typist.",

    modifier = Modifier

                .align(Alignment.Center),

    typistSpeed = TypistSpeed.NORMAL,

    textStyle = TextStyle(

        color = Color.Red,

        fontWeight = FontWeight.Bold,

        fontSize = 28.sp,

        textAlign = TextAlign.Center,

        isBlinkingCursor = true, // if true the cursor will keep blinking

        isInfiniteCursor = false, // if true the cursor will not hide even after the text has been written

        isCursorVisible = true, // if true the cursor will not be visible at all

    ),

onAnimationEnd = {},

onAnimationStart = {}

)

```