Specs

inc(id: id(), step: integer()) :: :ok

Increases current value by step.

When current value becomes equal to total, then progress bar terminates.

Options

• :id - an required identifier of the progress bar.
• :step - a value by which current value should be increased. Defaults to 1.

Examples

Owl.ProgressBar.inc(id: "Creating users")

Owl.ProgressBar.inc(id: "Creating users", step: 10)

Specs

render(%{
  optional(:current_time) => nil | integer(),
  optional(:start_time) => nil | integer(),
  optional(:screen_width) => nil | pos_integer(),
  bar_width_ratio: float(),
  label: String.t(),
  total: pos_integer(),
  current: non_neg_integer(),
  start_symbol: Owl.Data.t(),
  end_symbol: Owl.Data.t(),
  filled_symbol: Owl.Data.t(),
  partial_symbols: [Owl.Data.t()],
  empty_symbol: Owl.Data.t()
}) :: Owl.Data.t()

Renders a progress bar that can be consumed by Owl.IO.puts/2.

Used as a callback for blocks in Owl.LiveScreen.

Examples

iex> Owl.ProgressBar.render(%{
...>   label: "Demo",
...>   total: 200,
...>   current: 60,
...>   bar_width_ratio: 0.7,
...>   start_symbol: "[",
...>   end_symbol: "]",
...>   filled_symbol: "#",
...>   partial_symbols: [],
...>   empty_symbol: ".",
...>   screen_width: 40
...> }) |> to_string()
"Demo [########....................]  30%"

iex> Owl.ProgressBar.render(%{
...>   label: "Demo",
...>   total: 200,
...>   current: 8,
...>   bar_width_ratio: 0.4,
...>   start_symbol: "|",
...>   end_symbol: "|",
...>   filled_symbol: "█",
...>   partial_symbols: ["▏", "▎", "▍", "▌", "▋", "▊", "▉"],
...>   empty_symbol: " ",
...>   screen_width: 40,
...>   start_time: -576460748012758993,
...>   current_time: -576460748012729828
...> }) |> to_string()
"Demo     00:29.2 |▋               |   4%"

iex> Owl.ProgressBar.render(%{
...>   label: "Demo",
...>   total: 200,
...>   current: 8,
...>   bar_width_ratio: 0.7,
...>   start_symbol: "[",
...>   end_symbol: "]",
...>   filled_symbol: Owl.Tag.new("≡", :cyan),
...>   partial_symbols: [Owl.Tag.new("-", :green), Owl.Tag.new("=", :blue)],
...>   empty_symbol: " ",
...>   screen_width: 40
...> })|> Owl.Data.to_ansidata() |> to_string
"Demo [≡-                          ]   4%"

Specs

start(
  label: String.t(),
  id: id(),
  total: pos_integer(),
  timer: boolean(),
  current: non_neg_integer(),
  bar_width_ratio: nil | float(),
  start_symbol: Owl.Data.t(),
  end_symbol: Owl.Data.t(),
  filled_symbol: Owl.Data.t(),
  partial_symbols: [Owl.Data.t()],
  empty_symbol: Owl.Data.t(),
  screen_width: pos_integer()
) :: DynamicSupervisor.on_start_child()

Starts a progress bar on Owl.LiveScreen.

Options

• :id - an id of the progress bar. Required.
• :label - a label of the progress bar. Required.
• :total - a total value. Required.
• :current - a current value. Defaults to 0.
• :bar_width_ratio - a bar width ratio. Defaults to 0.7.
• :timer - set to true to launch a timer. Defaults to false.
• :start_symbol - a symbol that is rendered at the beginning of the progress bar. Defaults to "[".
• :end_symbol - a symbol that rendered at the end of the progress bar. Defaults to "]".
• :filled_symbol - a symbol that use used when current value is big enough to fill the cell. Defaults to "≡"
• :partial_symbols - a list of symbols that are used when current value is too small to render filled_symbol. Defaults to ["-", "="].
• :empty_symbol - an empty symbol. Defaults to " ".
• :screen_width - a width of output data. Defaults to width of the terminal or 80 symbols, if a terminal is not available.