| cli_bullets {cli} | R Documentation |
It is often useful to print out a list of items, tasks a function or package performs, or a list of notes.
cli_bullets(text, id = NULL, class = NULL, .envir = parent.frame())
text |
Character vector of items. See details below on how names are interpreted. |
id |
Optional id of the |
class |
Optional additional class(es) for the |
.envir |
Environment to evaluate the glue expressions in. |
Items may be formatted differently, e.g. they can have a prefix symbol.
Formatting is specified by the names of text, and can be themed.
cli creates a div element of class memo for the whole memo. Each
item is another div element of class memo-item-<name>, where
<name> is the name of the entry in text. Entries in text without
a name create a div element of class memo-item-empty, and if the
name is a single space character, the class is memo-item-space.
The built-in theme defines the following item types:
No name: Item without a prefix.
: Indented item.
*: Item with a bullet.
>: Item with an arrow or pointer.
v: Item with a green "tick" symbol, like cli_alert_success().
x: Item with a ref cross, like cli_alert_danger().
!: Item with a yellow exclamation mark, like cli_alert_warning().
i: Info item, like cli_alert_info().
You can define new item type by simply defining theming for the
corresponding memo-item-<name> classes.
cli_bullets(c(
"noindent",
" " = "indent",
"*" = "bullet",
">" = "arrow",
"v" = "success",
"x" = "danger",
"!" = "warning",
"i" = "info"
))