cli-frames

Create CLI animations using text frames.

Installation

$ npm i --save cli-frames

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
            });
        }
    }
});

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.

How to contribute

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

Where is this library used?

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

• audrey-animation by Lucas_C / llucbrell

• gif-cli

• grumpycat by Ayhan Kuru

• kamehameha.js

• text-animation

License

MIT © Ionică Bizău