code.delx.au - gnu-emacs-elpa/blob - packages/spinner/README.org

   1 #+TITLE: spinner.el
   2
   3 Add spinners and progress-bars to the mode-line for ongoing operations.
   4
   5 [[file:some-spinners.gif]]
   6
   7 [[file:all-spinners.gif]]
   8
   9 * Usage
  10
  11 1. Add ~(spinner "1.0")~ to your package’s dependencies.
  12
  13 2. Call ~(spinner-start)~ and a spinner will be added to the mode-line.
  14
  15 3. Call ~(spinner-stop)~ on the same buffer when you want to remove it.
  16
  17 * Behavior
  18
  19 The default spinner is a line drawing that rotates. You can pass an
  20 argument to ~spinner-start~ to specify which spinner you want. All
  21 possibilities are listed in the ~spinner-types~ variable, but here are
  22 a few examples for you to try:
  23
  24 - ~(spinner-start 'vertical-breathing 10)~
  25 - ~(spinner-start 'minibox)~
  26 - ~(spinner-start 'moon)~
  27 - ~(spinner-start 'triangle)~