Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mdgspace/rotatingtext
A periodic text updating library
https://github.com/mdgspace/rotatingtext
android android-library textview
Last synced: about 1 month ago
JSON representation
A periodic text updating library
- Host: GitHub
- URL: https://github.com/mdgspace/rotatingtext
- Owner: mdgspace
- License: mit
- Created: 2017-05-01T18:02:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-11T09:31:06.000Z (over 4 years ago)
- Last Synced: 2024-07-30T14:17:43.763Z (4 months ago)
- Topics: android, android-library, textview
- Language: Java
- Size: 4.95 MB
- Stars: 1,585
- Watchers: 26
- Forks: 169
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# RotatingText
[](https://www.android.com)
[](https://android-arsenal.com/api?level=16s)
[](https://opensource.org/licenses/MIT)
[](http://mdg.iitr.ac.in)
Rotating text is an Android library that can be used to make text switching painless and beautiful, with the use of interpolators, typefaces and more customisations.
# Usage
Just add the following dependency in your app's `build.gradle`
```
dependencies {
compile 'com.sdsmdg.harjot:rotatingtext:1.0.2'
}
```
## Example Usage 1 (Simple)
#### XML
```
```
#### Java
```
RotatingTextWrapper rotatingTextWrapper = (RotatingTextWrapper) findViewById(R.id.custom_switcher);
rotatingTextWrapper.setSize(35);
Rotatable rotatable = new Rotatable(Color.parseColor("#FFA036"), 1000, "Word", "Word01", "Word02");
rotatable.setSize(35);
rotatable.setAnimationDuration(500);
rotatingTextWrapper.setContent("This is ?", rotatable);
```
#### Result
## Example Usage 2 (Typeface + Interpolator)
#### XML
```
```
#### Java
```
Typeface typeface = Typeface.createFromAsset(getAssets(), "fonts/Raleway-Light.ttf");
Typeface typeface2 = Typeface.createFromAsset(getAssets(), "fonts/Reckoner_Bold.ttf");
RotatingTextWrapper rotatingTextWrapper = (RotatingTextWrapper) findViewById(R.id.custom_switcher);
rotatingTextWrapper.setSize(35);
rotatingTextWrapper.setTypeface(typeface2);
Rotatable rotatable = new Rotatable(Color.parseColor("#FFA036"), 1000, "Word", "Word01", "Word02");
rotatable.setSize(35);
rotatable.setAnimationDuration(500);
rotatable.setTypeface(typeface);
rotatable.setInterpolator(new BounceInterpolator());
rotatingTextWrapper.setContent("This is ?", rotatable);
```
#### Result
## Example Usage 3 (Multiple Rotatables)
#### XML
```
```
#### Java
```
Typeface typeface = Typeface.createFromAsset(getAssets(), "fonts/Raleway-Light.ttf");
Typeface typeface2 = Typeface.createFromAsset(getAssets(), "fonts/Reckoner_Bold.ttf");
RotatingTextWrapper rotatingTextWrapper = (RotatingTextWrapper) findViewById(R.id.custom_switcher);
rotatingTextWrapper.setSize(35);
rotatingTextWrapper.setTypeface(typeface2);
Rotatable rotatable = new Rotatable(Color.parseColor("#FFA036"), 1000, "Word", "Word01", "Word02");
rotatable.setSize(35);
rotatable.setTypeface(typeface);
rotatable.setInterpolator(new AccelerateInterpolator());
rotatable.setAnimationDuration(500);
Rotatable rotatable2 = new Rotatable(Color.parseColor("#123456"), 1000, "Word03", "Word04", "Word05");
rotatable2.setSize(25);
rotatable2.setTypeface(typeface);
rotatable2.setInterpolator(new DecelerateInterpolator());
rotatable2.setAnimationDuration(500);
rotatingTextWrapper.setContent("This is ? and ?", rotatable, rotatable2);
```
#### Result
# Documentation
Rotating text is made of two parts : `RotatingTextWrapper` and `Rotatable`.
Each rotatable encapsulates the collection of words that are two be periodically switched and also defines various properties related to these words, like, size, color, animation interpolator etc.
Each Rotatable must be a part of a `RotatingTextWrapper`. This defines the actual layout of the text and the positions of the rotating text.
For eg : `rotatingTextWrapper.setContent("This is ?", rotatble);`. Here the `?` denotes the postion of the `rotatable`.
## RotatingTextWrapper
|Property |Function |Description |
|-----------------|------------------------|----------------------------------------|
|Content | setContent(...) | Set the actual content. Composed of a String and array of Rotatables. |
|Typeface | setTypeface(...) | Set the typeface of the non-rotating text |
|Size | setSize(...) | Set the size of the non-rotating text |
|Pause | pause(x) | Method to pause the 'x'th rotatable |
|Resume | resume(x) | Method to resume the 'x'th rotatable |
## Rotatable
|Property |Function |Description |
|-----------------|------------------------|----------------------------------------|
|Color | setColor(...) | Set the color of the rotating text associated with this rotatable |
|Size | setSize(...) | Set the size of the rotating text associated with this rotatable |
|Typeface | setTypeface(...) | Set the typeface of the rotating text associated with this rotatable |
|Interpolator | setInterpolator(...) | Set the animation interpolator used while switching text |
|Update Duration | setUpdateDuration(...) | Set the interval between switching the words |
|Animation Duration | setAnimationDuration(...) | Set the duration of the switching animation |
|Center Align | setCenter(...) |Align the rotating text to center of the textview if set to **true** |
# License
RotatingText is licensed under `MIT license`. View [license](LICENSE.md).