← Back to Components
Progress
Embedded, server-driven progress bar that renders inline instead of as a notification panel.
Interactive Playground
R Code
API Reference
block_progress()
Embedded, display-only progress bar that renders inline where placed (not as a Shiny notification panel) and is driven from the server.
| Argument | Type | Default | Description |
|---|---|---|---|
| id | character | required | Component id used to address the bar from the server. Not a form control: no input$<id> value. |
| value | numeric | 0 | Current progress value, clamped into [min, max]. |
| min | numeric | 0 | Lower bound. Must be finite and less than max. |
| max | numeric | 1 | Upper bound. Must be finite and greater than min. |
| message | character | NULL | Dynamic status line; header-left, or a muted second line when label is also set. |
| detail | character | NULL | Secondary muted text below the track. |
| label | character | NULL | Static description of what is progressing; takes header-left when set. |
| show_value | logical | FALSE | Render the clamped percent at header-right. Suppressed when indeterminate. |
| indeterminate | logical | FALSE | Show an unknown-progress sweep instead of a determinate fill. |
| variant | 'default' | 'success' | 'warning' | 'info' | 'destructive' | 'default' | Indicator color. |
| width | character | NULL | CSS width for the component (NULL fills the container); sizes the mount wrapper only. |
| class | character | NULL | Additional classes applied to the inner progress body (.sb-progress-body), not the mount wrapper. |
| style | character | list | NULL | Inline styles applied to the inner progress body (.sb-progress-body); use width for wrapper sizing. |
update_block_progress()
Set fields on a block_progress() from the server. Omitted args preserve the client value; NULL clears text fields; NULL on numeric fields errors.
| Argument | Type | Default | Description |
|---|---|---|---|
| session | ShinySession | getDefaultReactiveDomain() | The Shiny session. |
| id | character | required | Component id passed to block_progress(). |
| value / min / max | numeric | — | Replacement scale; clamped/reconciled client-side. |
| message / detail / label | character | — | Replacement text; NULL clears. |
| show_value / indeterminate | logical | — | Replacement state flags. |
| variant | character | — | Replacement indicator color. |
| class / style | character | list | — | Replacement classes/styles; NULL clears. |
inc_block_progress()
Increment a block_progress() by a signed amount, saturating at the bounds. Reaching max is a stable no-op state.
| Argument | Type | Default | Description |
|---|---|---|---|
| session | ShinySession | getDefaultReactiveDomain() | The Shiny session. |
| id | character | required | Component id passed to block_progress(). |
| amount | numeric | 0.1 | Signed amount added to the current value (may be negative). |
| message / detail | character | — | Optional text updates applied alongside the increment. |