The rule can include either a centered text label, or labels on the left and right side.
To color the labels, use the functions col_*
, bg_*
and style_*
functions, see ANSI styles, and the examples below.
To color the line, either these functions directly, or the line_col
option.
Usage
rule(
left = "",
center = "",
right = "",
line = 1,
col = NULL,
line_col = col,
background_col = NULL,
width = console_width()
)
Arguments
- left
Label to show on the left. It interferes with the
center
label, only at most one of them can be present.- center
Label to show at the center. It interferes with the
left
andright
labels.- right
Label to show on the right. It interferes with the
center
label, only at most one of them can be present.- line
The character or string that is used to draw the line. It can also
1
or2
, to request a single line (Unicode, if available), or a double line. Some strings are interpreted specially, see Line styles below.- col
Color of text, and default line color. Either an ANSI style function (see ANSI styles), or a color name that is passed to
make_ansi_style()
.- line_col, background_col
Either a color name (used in
make_ansi_style()
), or a style function (see ANSI styles), to color the line and background.- width
Width of the rule. Defaults to the
width
option, seebase::options()
.