# `ExRatatui.Widgets.Gauge`
[🔗](https://github.com/mcass19/ex_ratatui/blob/v0.10.1/lib/ex_ratatui/widgets/gauge.ex#L1)

A progress bar widget.

## Fields

  * `:ratio` - progress value, a number in `0.0..1.0`. Integers `0` and `1`
    are accepted and coerced to floats. Any other value raises
    `ArgumentError` at render time.
  * `:label` - optional label string displayed on the gauge
  * `:style` - `%ExRatatui.Style{}` for the widget background
  * `:block` - optional `%ExRatatui.Widgets.Block{}` container
  * `:gauge_style` - `%ExRatatui.Style{}` for the filled portion

## Examples

    iex> %ExRatatui.Widgets.Gauge{ratio: 0.75, label: "75%"}
    %ExRatatui.Widgets.Gauge{
      ratio: 0.75,
      label: "75%",
      style: %ExRatatui.Style{},
      block: nil,
      gauge_style: %ExRatatui.Style{}
    }

# `t`

```elixir
@type t() :: %ExRatatui.Widgets.Gauge{
  block: ExRatatui.Widgets.Block.t() | nil,
  gauge_style: ExRatatui.Style.t(),
  label: String.t() | nil,
  ratio: float(),
  style: ExRatatui.Style.t()
}
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*
