The typewriter-textview from nitishgadangi

typewriter-textview's Introduction

Demo

Gradle Dependency

To get a Git project into your build:

Step 1. Add the JitPack repository to your build file

Add it in your project level build.gradle at the end of repositories:

	allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}

Step 2. Add the dependency to app level build.gradle file

	dependencies {
	        implementation 'com.github.NitishGadangi:TypeWriter-TextView:v1.3'
	}

Usage

Step 1. Add TypeWriterView to your XML file

<com.nitish.typewriterview.TypeWriterView  
  android:id="@+id/typeWriterView"  
  android:layout_width="match_parent"  
  android:layout_height="wrap_content"  
 />

Step 2. Start animation in Activity or Fragment

TypeWriterView typeWriterView = findViewById(R.id.typeWriterView);
typeWriterView.animateText("Insert your text here");

Listeners and Functions

Callback for OnAnimation End

typeWriterView.setOnAnimationChangeListener(new TypeWriterView.OnAnimationChangeListener() {  
    @Override  
  public void onAnimationEnd() {  
          //Do something
    }  
});

Other Functions

typeWriterView.isAnimationRunning(); //returns true if animation is still running
typeWriterView.stopAnimation(); //Stop the ongoing animation
typeWriterView.isTextInitialised(); //returns false if animation is not started

Customization

By default

avoidTextOverflowAtEdge = true;
characterDelay = 40; //in ms

You can modify the following values

//set characterDelay in ms
typeWriterView.setCharacterDelay(long millis);
//making this false will turnoff adding new line when the view hits the end of the view
typeWriterView.avoidTextOverflowAtEdge(boolean avoidTextOverflowAtEdge);

Contributing

Pull requests are welcome, if you have any questions feel free to ping me.

Like my work?

Made with ❤️ by Nitish

typewriter-textview's People

Contributors

Stargazers

Watchers

typewriter-textview's Issues

Write Inline Documentation for Public Methods

Heading says it all...

Setting the animation on loop parameter would be helpful

Crashing Caused by Index Out of bound

getting this index out of bound exception Error No reason at all

  java.lang.StringIndexOutOfBoundsException: begin 0, end 32, length 31
                 	at java.lang.String.checkBoundsBeginEnd(String.java:4466)
                 	at java.lang.String.substring(String.java:2517)
                 	at java.lang.String.subSequence(String.java:2567)
                 	at com.nitish.typewriterview.TypeWriterView$1.run(TypeWriterView.java:31)
                 	at android.os.Handler.handleCallback(Handler.java:942)
                 	at android.os.Handler.dispatchMessage(Handler.java:99)
                 	at android.os.Looper.loopOnce(Looper.java:204)
                 	at android.os.Looper.loop(Looper.java:291)
                 	at android.app.ActivityThread.main(ActivityThread.java:8134)
                 	at java.lang.reflect.Method.invoke(Native Method)
                 	at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:601)
                 	at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1019)

here is my Implementation if you can help narrow down the issue please help

` private fun makeTypingText() {

    homeBinding.searchWriterView.setCharacterDelay(80)
    homeBinding.searchWriterView.animateText("Explore Deliciousness in Every Search..")


    homeBinding.searchWriterView.setOnAnimationChangeListener {
        Handler(Looper.getMainLooper()).postDelayed(Runnable {
            if ([email protected]) {
                try {
                    if (index == 4) {
                        index = 0
                    }
                    index++

                    homeBinding.searchWriterView.animateText(makeTestList(index))
                }catch (e:Exception){
                    e.printStackTrace()
                }

            }
        }, 1500)
    }



}
val animatableText: ArrayList<String> = ArrayList()

private fun makeTestList(index: Int): String {
    if(animatableText.isEmpty()) {
        animatableText.add("Explore Deliciousness in Every Search..")
        animatableText.add("Find Flavorful Delights Here...")
        animatableText.add("Explore Deliciousness...")
        animatableText.add("Where Every Bite Speaks Flavor...")
        animatableText.add("Uncover Delicious Treasures Instantly...")
    }
    return animatableText[index]
}`

Recommend Projects