Unordered CLI list — cli

An unordered list is a container, see containers.

cli_ul(
  items = NULL,
  id = NULL,
  class = NULL,
  .close = TRUE,
  .auto_close = TRUE,
  .envir = parent.frame()
)

Arguments

items	If not `NULL`, then a character vector. Each element of the vector will be one list item, and the list container will be closed by default (see the `.close` argument).
id	Id of the list container. Can be used for closing it with `cli_end()` or in themes. If `NULL`, then an id is generated and retuned invisibly.
class	Class of the list container. Can be used in themes.
.close	Whether to close the list container if the `items` were specified. If `FALSE` then new items can be added to the list.
.auto_close	Whether to close the container, when the calling function finishes (or `.envir` is removed, if specified).
.envir	Environment to evaluate the glue expressions in. It is also used to auto-close the container if `.auto_close` is `TRUE`.

Value

The id of the new container element, invisibly.

Examples

## Specifying the items at the beginning
cli_ul(c("one", "two", "three"))
#>   ─ one
#>   ─ two
#>   ─ three

## Adding items one by one
cli_ul()
cli_li("one")
#>   ─ one
cli_li("two")
#>   ─ two
cli_li("three")
#>   ─ three
cli_end()

## Complex item, added gradually.
cli_ul()
cli_li()
cli_verbatim("Beginning of the {.emph first} item")
#>   Beginning of the {.emph first} item
cli_text("Still the first item")
#>   Still the first item
cli_end()
cli_li("Second item")
#>   ─ Second item
cli_end()