Description Usage Arguments Details
View source: R/progress-client.R
This is a simplified progress bar, a single (dynamic) message, without progress units.
1 2 3 4 5 6 7 8 9 10 11 | cli_progress_step(
msg,
msg_done = msg,
msg_failed = msg,
spinner = FALSE,
class = if (!spinner) ".alert-info",
current = TRUE,
.auto_close = TRUE,
.envir = parent.frame(),
...
)
|
msg |
Message to show. It may contain glue substitution and cli
styling. It can be updated via |
msg_done |
Message to show on successful termination. By default
this it is the same as |
msg_failed |
Message to show on unsuccessful termination. By
default it is the same as |
spinner |
Whether to show a spinner at the beginning of the line.
To make the spinner spin, you'll need to call |
class |
cli class to add to the message. By default there is no class for steps with a spinner. |
current |
Passed to |
.auto_close |
Passed to |
.envir |
Passed to |
... |
Passed to |
cli_progress_step()
always shows the progress message,
even if no update is due.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.