Create beautiful ASCII text animations using NodeJS.
# Using npmnpm install --save text-animation# Using yarnyarn add text-animation
// Dependenciesvar TextAnimation = ;// Animate bottom-top;
❓ Get Help
There are few ways to get help:
- Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
- For bug reports and feature requests, open issues. 🐛
- For direct and quick help, you can use Codementor. 🚀
Creates the animation with provided text.
options: The string value with the text that you want to animate or an object containing the following fields:
text(String): The text that you want to animate.
end(Function): The handler that will be called when the animation is eneded. If the
callbackparameter is provided, then this field will be overridden (default: an empty function).
animation(String): The animation type. Actually, this is one of filenames from
delay(Number): The frame delay in milliseconds (default:
size(String): The size of the box in the following format:
WIDTHxHEIGHT. If this is not provided, the box will take the fullscreen size.
font(String): The text font (default:
Additional fields are added to
size(Array): The provided string is splitted and the value will be an array.
box(CliBox): The CliBox wrapper object.
rText(String): The rendered text using the Figlet lirary. This is added asynchronously.
callback: The callback function.
😋 How to contribute
Have an idea? Found a bug? See how to contribute.
💖 Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
Starring and sharing the projects you like 🚀
Bitcoin—You can send me bitcoins at this address (or scanning the code below):
💫 Where is this library used?
If you are using this library in one of your projects, add it in this list. ✨