ansi_strtrim {cli} | R Documentation |
Truncate an ANSI string
Description
This function is similar to base::strtrim()
, but works correctly with
ANSI styled strings. It also adds ...
(or the corresponding Unicode
character if Unicode characters are allowed) to the end of truncated
strings.
Usage
ansi_strtrim(x, width = console_width(), ellipsis = symbol$ellipsis)
Arguments
x |
Character vector of ANSI strings. |
width |
The width to truncate to. |
ellipsis |
The string to append to truncated strings. Supply an empty string if you don't want a marker. |
Details
Note: ansi_strtrim()
does not support NA values currently.
See Also
Other ANSI string operations:
ansi_align()
,
ansi_columns()
,
ansi_nchar()
,
ansi_strsplit()
,
ansi_strwrap()
,
ansi_substring()
,
ansi_substr()
,
ansi_toupper()
,
ansi_trimws()
Examples
text <- cli::col_red(cli:::lorem_ipsum())
ansi_strtrim(c(text, "foobar"), 40)
[Package cli version 3.6.3 Index]