cli-frames

Create CLI animations using text frames.

:cloud: Installation

# Using npm
npm install --save cli-frames

# Using yarn
yarn add cli-frames

:clipboard: Example

// Dependencies
var CliFrames = require("cli-frames");

// Frames
const frames = [
    "╔════╤╤╤╤════╗\n" +
    "║    │││ \\   ║\n" +
    "║    │││  O  ║\n" +
    "║    OOO     ║",

    "╔════╤╤╤╤════╗\n" +
    "║    ││││    ║\n" +
    "║    ││││    ║\n" +
    "║    OOOO    ║",

    "╔════╤╤╤╤════╗\n" +
    "║   / │││    ║\n" +
    "║  O  │││    ║\n" +
    "║     OOO    ║",

    "╔════╤╤╤╤════╗\n" +
    "║    ││││    ║\n" +
    "║    ││││    ║\n" +
    "║    OOOO    ║"
];

// Load frames when creating the instance
new CliFrames({
    frames: ["5", "4", "3", "2", "1"]
  , autostart: {
        delay: 1000
      , end: function (err, data) {
            // Create another animation
            var animation = new CliFrames();
            animation.load(frames);
            animation.start({
                repeat: true
              , delay: 250
            });
        }
    }
});

: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

CliFrames(opt_options)

Creates a new instance of CliFrames.

Params

• Object opt_options: An optional object containing:
• frames (Array): The frames to be loaded.
• autostart (Object): If provided, the animation will be autostarted. The object will be provided to start function.

Return

• CliFrames The CliFrames instance.

load(options)

Loads the animation frames.

Params

• Object options: An array of strings representing the animation frames.

Return

• CliFrames The CliFrames instance.

start(options)

Starts the CLI animation.

Params

• Object options: An object containing the following fields:
• delay (Number): The frame delay in milliseconds (default: 100).
• repeat (Boolean): If true, the animation will be repeated infinitely.

Return

• CliFrames The CliFrames instance.

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

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

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

• —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:

• text-animation
• gif-cli
• ihpm
• tomgreen
• kamehameha.js
• audrey-animation
• terminal-parrot
• grumpycat
• @telusdigital/shippy-cli
• @sbayet/card
• ascii-tarot
• @telus/shippy-cli

:scroll: License

MIT © Ionică Bizău