Definition list

A definition list is a container, see containers.

Usage

cli_dl(
  items = NULL,
  labels = names(items),
  id = NULL,
  class = NULL,
  .close = TRUE,
  .auto_close = TRUE,
  .envir = parent.frame()
)

items: Named character vector, or NULL. If not NULL, they are used as list items.
labels: Item labels. Defaults the names in items.
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 returned 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.

The id of the new container element, invisibly.

fun <- function() {
  cli_dl(c(foo = "one", bar = "two", baz = "three"))
}
fun()

#> foo: one
#> bar: two
#> baz: three

fun <- function() {
  cli_dl()
  cli_li(c(foo = "{.emph one}"))
  cli_li(c(bar = "two"))
  cli_li(c(baz = "three"))
}
fun()

#> foo: one
#> bar: two
#> baz: three