braille-pattern-cli-loading-indicator

Animated CLI loading indicator using Unicode braille patterns

Usage no npm install needed!

<script type="module">
  import braillePatternCliLoadingIndicator from 'https://cdn.skypack.dev/braille-pattern-cli-loading-indicator';
</script>

README

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')

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

loadingIndicator.start()

setTimeout(function () {
  loadingIndicator.stop()
  console.log('done 💥')
}, 5000)

credits

heavily inspired by heroku cli loading indicator