cli_spinners v0.1.0 CliSpinners.Spinner

#Intro This is real spinner module. This module is responsible for the actual spinning process. This is where the spinning configuration, rendering frame and getting appropriate list frames based on the atom passed.

Summary

Functions

render(custom_format \\ [frames: :line, spinner_color: [], text: "Loading…", done: "Loaded.", interval: 100], fun)

This is actual definition for rendering spinning animation. This usuallly takes Two prameters. This firs param is configuration which is optional and the second one is function

Functions

render(custom_format \\ [frames: :line, spinner_color: [], text: "Loading…", done: "Loaded.", interval: 100], fun)

This is actual definition for rendering spinning animation. This usuallly takes Two prameters. This firs param is configuration which is optional and the second one is function.

The animation begins once if the confuguration is set with the given format. This animation lasts long until the function finishes its code of execution. The animation stops once if the function raise the exception.

Examples

iex> ClisSpinner.Spinner.render([text: "Please wait...",frames: ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]])

iex> CliSpinners.Spinner.render([text: “collecting…”,frames: :dots]) iex> CliSpinners.Spinner.render_()