cli_ol: Ordered CLI list
In r-lib/cliapp: Create Rich Command Line Applications

cli_ol

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 `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_ol(c("one", "two", "three"))

## Adding items one by one
cli_ol()
cli_it("one")
cli_it("two")
cli_it("three")
cli_end()

## Nested lists
cli_div(theme = list(ol = list("margin-left" = 2)))
cli_ul()
cli_it("one")
cli_ol(c("foo", "bar", "foobar"))
cli_it("two")
cli_end()
cli_end()

r-lib/cliapp documentation built on Nov. 9, 2023, 11:18 a.m.