rule: Make a rule with one or two text labels

In RonMobile/cli: Helpers for Developing Command Line Interfaces

Description

The rule can include either a centered text label, or labels on the left and right side.

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 and right 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 or 2, 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, see base::options().

Details

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.

Value

Character scalar, the rule.

Line styles

Some strings for the line argument are interpreted specially:

• "single": (same as 1), a single line,

• "double": (same as 2), a double line,

• "bar1", "bar2", "bar3", etc., "bar8" uses varying height bars.

Examples

## Simple rule
rule()

## Double rule
rule(line = 2)

## Bars
rule(line = "bar2")
rule(line = "bar5")

## Left label
rule(left = "Results")

## Centered label
rule(center = " * RESULTS * ")

## Colored labels
rule(center = col_red(" * RESULTS * "))

## Colored line
rule(center = col_red(" * RESULTS * "), line_col = "red")

## Custom line
rule(center = "TITLE", line = "~")

## More custom line
rule(center = "TITLE", line = col_blue("~-"))

## Even more custom line
rule(center = bg_red(" ", symbol$star, "TITLE",
  symbol$star, " "),
  line = "\u2582",
  line_col = "orange")

RonMobile/cli documentation built on Dec. 18, 2021, 11 a.m.