Skip to content

basic_ratio

Single Ratio (0..=1) authored inline in config. Pairs with any gauge renderer. Clamps out-of-range values silently — the splash should never be unable to render because of one bad number.

Kind	Safety	Shapes
realtime	Safe	`ratio`

Options

Option	Type	Required	Default	Description
`value`	float (clamped to 0.0..=1.0)	yes	—	Progress as a fraction. Out-of-range values are clamped rather than rejected so a misconfig still renders.
`label`	string	no	—	Optional caption shown beside the gauge.
`denominator`	u64	no	—	Optional total the value is a fraction of (e.g. `denominator = 365` when value tracks day-of-year). Lets renderers print `N of M` instead of percent-only.

Compatible renderers

Shape	Renderers
`ratio`	`animated_boot`, `animated_postfx`, `animated_scanlines`, `animated_splitflap`, `animated_wave`, `gauge_battery`, `gauge_circle`, `gauge_line`, `gauge_segment`, `gauge_thermometer`

Preview

`ratio` via `gauge_battery`

                                        
       ┌──────────────────────────┐     
Q2 OKR │████████████████░░░░░░░░░░│▮ 60%
       └──────────────────────────┘

[[widget]]
id = "basic_ratio"
fetcher = "basic_ratio"
render = "gauge_battery"

`ratio` via `gauge_circle`

████████████████████████                
█████████████████Q2 OKR                 
████████████████████████

[[widget]]
id = "basic_ratio"
fetcher = "basic_ratio"
render = "gauge_circle"

`ratio` via `gauge_line`

Q2 OKR: ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░░ 60%

[[widget]]
id = "basic_ratio"
fetcher = "basic_ratio"
render = "gauge_line"

`ratio` via `gauge_segment`

                                        
                                        
Q2 OKR ▰▰▰▱▱ 60%

[[widget]]
id = "basic_ratio"
fetcher = "basic_ratio"
render = "gauge_segment"

`ratio` via `gauge_thermometer`

       ╭─╮          
       │░│          
       │░│          
       │█│          
Q2 OKR │█│ 60%      
       │█│          
       │█│          
       ╰●╯

[[widget]]
id = "basic_ratio"
fetcher = "basic_ratio"
render = "gauge_thermometer"