cli_ol {cli} | R Documentation |
Ordered CLI list
Description
An ordered list is a container, see containers.
Usage
cli_ol(
items = NULL,
id = NULL,
class = NULL,
.close = TRUE,
.auto_close = TRUE,
.envir = parent.frame()
)
Arguments
items |
If not |
id |
Id of the list container. Can be used for closing it with
|
class |
Class of the list container. Can be used in themes. |
.close |
Whether to close the list container if the |
.auto_close |
Whether to close the container, when the calling
function finishes (or |
.envir |
Environment to evaluate the glue expressions in. It is
also used to auto-close the container if |
Details
Adding all items at once
fun <- function() { cli_ol(c("one", "two", "three")) } fun()
#> 1. one #> 2. two #> 3. three
Adding items one by one
## Adding items one by one fun <- function() { cli_ol() cli_li("{.emph one}") cli_li("{.emph two}") cli_li("{.emph three}") cli_end() } fun()
#> 1. one #> 2. two #> 3. three
Nested lists
fun <- function() { cli_div(theme = list(ol = list("margin-left" = 2))) cli_ul() cli_li("one") cli_ol(c("foo", "bar", "foobar")) cli_li("two") cli_end() cli_end() } fun()
#> • one #> 1. foo #> 2. bar #> 3. foobar #> • two
Value
The id of the new container element, invisibly.
See Also
This function supports inline markup.
Other functions supporting inline markup:
cli_abort()
,
cli_alert()
,
cli_blockquote()
,
cli_bullets_raw()
,
cli_bullets()
,
cli_dl()
,
cli_h1()
,
cli_li()
,
cli_process_start()
,
cli_progress_along()
,
cli_progress_bar()
,
cli_progress_message()
,
cli_progress_output()
,
cli_progress_step()
,
cli_rule
,
cli_status_update()
,
cli_status()
,
cli_text()
,
cli_ul()
,
format_error()
,
format_inline()