h1: Heading level 1 *[Experimental]*

In rappster/clix: A custom CLI implementation

Heading level 1

Description

Mainly a "decoupling wrapper" around cli::cli_h1() with some additional features.

Usage

h1(text, step = 0, steps_max = 0, .width = 80, .envir = parent.frame())

Arguments

text	(character) Text of the heading. It can contain inline markup.
step	(integer) Denote which process step this is.
steps_max	(integer) Denote how many process steps there are in total
.width	(integer) Line width. Currently not compatible with. cli::cli_h1() but possibly usefule in the future.
.envir	(environment) Environment to evaluate the glue expressions in.

Examples

h1("This is a title")

rappster/clix documentation built on Aug. 16, 2022, 9:54 p.m.