This function can be used directly, or via the {.val ...} inline
style. {.val {expr}} calls cli_format() automatically on the value
of expr, before styling and collapsing it.
Usage
cli_format(x, style = NULL, ...)
# S3 method for default
cli_format(x, style = NULL, ...)
# S3 method for character
cli_format(x, style = NULL, ...)
# S3 method for numeric
cli_format(x, style = NULL, ...)Arguments
- x
The object to format.
- style
List of formatting options, see the individual methods for the style options they support.
- ...
Additional arguments for methods.
Details
Default style
months <- month.name[1:3]
cli_text("{.val {months}}")#> "January", "February", and "March"
nums <- 1:5 / 7
cli_text("{.val {nums}}")#> 0.142857142857143, 0.285714285714286, 0.428571428571429, #> 0.571428571428571, and 0.714285714285714
Styling with themes
nums <- 1:5 / 7
divid <- cli_div(theme = list(.val = list(digits = 3)))
cli_text("{.val {nums}}")
cli_end(divid)#> 0.143, 0.286, 0.429, 0.571, and 0.714
It is possible to define new S3 methods for cli_format and then
these will be used automatically for {.val ...} expressions.
cli_format.month <- function(x, style = NULL, ...) {
x <- encodeString(substr(x, 1, 3), quote = "\"")
NextMethod("cli_format")
}
registerS3method("cli_format", "month", cli_format.month)
months <- structure(month.name[1:3], class = "month")
cli_text("{.val {months}}")#> "Jan", "Feb", and "Mar"