/braille-pattern-cli-loading-indicator

Animated command line loading indicator using Unicode braille patterns ⠾ ⠽ ⠻ ⠯ ⠷

Primary LanguageJavaScript

braille-pattern-cli-loading-indicator CircleCI NPM Version

Animated command line loading indicator using Unicode braille patterns (based on Heroku CLI).

size rotation preview sample code
large cw examples/formatted.js
small ccw examples/formatted-multicolor.js

usage

  • Use start() and stop() to enable or disable the loading indicator.
  • Optionally specify rotation as cw (clockwise) or ccw (counterclockwise)
  • Optionally provide a custom format function to add text or colors for the loading indicator.
'use strict'
const LoadingIndicator = require('braille-pattern-cli-loading-indicator')

const loader = new LoadingIndicator({
  size: 'large',
  rotation: 'cw',
  format: function (pattern) {
    return 'charging plasma cannon ' + pattern
  }
})

// Display loading indicator for 5 seconds, and then stop.
loader.start()
setTimeout(function () { loader.stop() }, 5000)

credits

heavily inspired by heroku cli loading indicator