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:spinner.gif]]
   6 * Usage
   7
   8 1. Add ~(spinner "1.0")~ to your package’s dependencies.
   9
  10 2. Call ~(spinner-start)~ and a spinner will be added to the mode-line.
  11
  12 3. Call ~(spinner-stop)~ on the same buffer when you want to remove it.
  13
  14 * Behavior
  15
  16 The default spinner is a line drawing that rotates. You can pass an
  17 argument to ~spinner-start~ to specify which spinner you want. All
  18 possibilities are listed in the ~spinner-types~ variable, but here are
  19 a few examples for you to try:
  20
  21 - ~(spinner-start 'vertical-breathing 10)~
  22 - ~(spinner-start 'minibox)~
  23 - ~(spinner-start 'moon)~
  24 - ~(spinner-start 'triangle)~