txt_style: Wraps text in html or latex code for formatting

In kbodwin/flair: Highlight, Annotate, and Format Your R Source Code

Wraps text in html or latex code for formatting

Description

txt_style adds appropriate html style wrappers to a string. Any number of options can be specified, as long as they match html CSS property names.

Usage

txt_style(
  x,
  type = "html",
  bold = FALSE,
  underline = FALSE,
  italics = FALSE,
  class = NULL,
  ...
)

txt_color(x, color = "red")

txt_colour(x, colour = "red")

txt_size(x, size = "large")

txt_background(x, bg_color = "#ffff7f")

txt_font(x, font)

txt_bold(x)

txt_emph(x)

txt_ul(x)

txt_tocode(x)

txt_tag(x, before, after)

Arguments

x	The string to be wrapped
type	The style of display, defaults to "html" (currently nothing else is supported, sorry)
bold	Should the text be bolded?
underline	Should the text be underlined?
italics	Should the text be italicized?
class	CSS classes applied to the '<span>' tag wrapping the text.
...	various display options: any html CSS style options, or one of font, size, color, background, style.
color	Named or html hex color for font.
colour	Named or html hex color for font.
size	Font size
bg_color	Named or html hex color for text background.
font	A valid font family.
before	String giving specific html tags to insert before text.
after	String giving specific html tags to insert after text.

Details

txt_* are shortcuts for specific individual style options

Warning: These are simple direct wrappers for strings only. If you are using decorated objects, you should instead use the flair functions.

Value

A string containing x with html wrappers.

See Also

flair

Examples

# General use
txt_style("I am highlighted!")
txt_style("I am blue and bold.", color = "blue", bold = TRUE)

# Shortcuts
txt_color("I am red.")
txt_color("I am blue.", color = "blue")

# Code styling wrapper
txt_tocode("I am code.")

# Can also use classes
txt_style("I am danger", class = "text-danger")

kbodwin/flair documentation built on Feb. 6, 2023, 4:24 p.m.