text-animation

Create beautiful ASCII text animations using NodeJS.

Stats

StarsIssuesVersionUpdatedCreatedSize
text-animation
1721.2.10a year ago8 years agoMinified + gzip package size for text-animation in KB

Readme

text-animation

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

Create beautiful ASCII text animations using NodeJS.

:cloud: Installation

# Using npm
npm install --save text-animation

# Using yarn
yarn add text-animation

:clipboard: Example

// Dependencies
var TextAnimation = require("text-animation");

// Animate bottom-top
TextAnimation("Hello...", function (err) {
    if (err) throw err;
    // And then, top-bottom
    TextAnimation({
        text: "...World!"
      , animation: "top-bottom"
    });
});

:question: Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. :bug:
  3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

TextAnimation(options, callback)

Creates the animation with provided text.

Params

  • String|Object 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 callback parameter is provided, then this field will be overridden (default: an empty function).

  • animation (String): The animation type. Actually, this is one of filenames from lib/animations directory (default: "bottom-top").

  • delay (Number): The frame delay in milliseconds (default: 100).

  • 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: "Graffiti").

Additional fields are added to options object:

  • 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.
  • Function callback: The callback function.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: 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 :rocket:

  • Buy me a book—I love books! I will remember you after years if you buy me one. :grin: :book:

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

  • happy-birthday-gabriel
  • kemila-docker

:scroll: License

MIT © Ionică Bizău

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.