R: Write A Customized Xaringan Theme

xaringanthemer_font_default {xaringanthemer}

R Documentation

Write A Customized Xaringan Theme

Description

Creates a customized Xaringan theme CSS file.

Usage

xaringanthemer_font_default(font_arg)

style_xaringan(
  text_color = "#000",
  header_color = "#000",
  background_color = "#FFF",
  link_color = "rgb(249, 38, 114)",
  text_bold_color = NULL,
  text_slide_number_color = inverse_background_color,
  padding = "16px 64px 16px 64px",
  background_image = NULL,
  background_size = NULL,
  background_position = NULL,
  code_highlight_color = "rgba(255,255,0,0.5)",
  code_inline_color = "#000",
  code_inline_background_color = NULL,
  code_inline_font_size = "1em",
  inverse_background_color = "#272822",
  inverse_text_color = "#d6d6d6",
  inverse_text_shadow = FALSE,
  inverse_header_color = "#f3f3f3",
  inverse_link_color = link_color,
  title_slide_text_color = inverse_text_color,
  title_slide_background_color = inverse_background_color,
  title_slide_background_image = NULL,
  title_slide_background_size = NULL,
  title_slide_background_position = NULL,
  footnote_color = NULL,
  footnote_font_size = "0.9em",
  footnote_position_bottom = "60px",
  left_column_subtle_color = "#777",
  left_column_selected_color = "#000",
  blockquote_left_border_color = "lightgray",
  table_border_color = "#666",
  table_row_border_color = "#ddd",
  table_row_even_background_color = "#eee",
  base_font_size = "20px",
  text_font_size = "1rem",
  header_h1_font_size = "2.75rem",
  header_h2_font_size = "2.25rem",
  header_h3_font_size = "1.75rem",
  header_background_auto = FALSE,
  header_background_color = header_color,
  header_background_text_color = background_color,
  header_background_padding = NULL,
  header_background_content_padding_top = "7rem",
  header_background_ignore_classes = c("normal", "inverse", "title", "middle", "bottom"),
  text_slide_number_font_size = "0.9rem",
  text_font_google = NULL,
  text_font_family = xaringanthemer_font_default("text_font_family"),
  text_font_weight = xaringanthemer_font_default("text_font_weight"),
  text_bold_font_weight = "bold",
  text_font_url = xaringanthemer_font_default("text_font_url"),
  text_font_family_fallback = xaringanthemer_font_default("text_font_family_fallback"),
  text_font_base = "sans-serif",
  header_font_google = NULL,
  header_font_family = xaringanthemer_font_default("header_font_family"),
  header_font_weight = xaringanthemer_font_default("header_font_weight"),
  header_font_family_fallback = "Georgia, serif",
  header_font_url = xaringanthemer_font_default("header_font_url"),
  code_font_google = NULL,
  code_font_family = xaringanthemer_font_default("code_font_family"),
  code_font_size = "0.9rem",
  code_font_url = xaringanthemer_font_default("code_font_url"),
  code_font_family_fallback = xaringanthemer_font_default("code_font_family_fallback"),
  link_decoration = "none",
  colors = NULL,
  extra_css = NULL,
  extra_fonts = NULL,
  outfile = "xaringan-themer.css"
)

Arguments

`font_arg`	A font argument from the xaringanthemer `style_` function family.
`text_color`	Text Color. Defaults to #000. Modifies the `body` element. The value of this variable is also stored as a CSS variable that can be referenced with `var(--text_color)` in any argument of a style function or in custom CSS.
`header_color`	Header Color. Defaults to #000. Modifies the `⁠h1, h2, h3⁠` elements. The value of this variable is also stored as a CSS variable that can be referenced with `var(--header-color)` in any argument of a style function or in custom CSS.
`background_color`	Slide Background Color. Defaults to #FFF. Modifies the `.remark-slide-content` class. The value of this variable is also stored as a CSS variable that can be referenced with `var(--background-color)` in any argument of a style function or in custom CSS.
`link_color`	Link Color. Defaults to rgb(249, 38, 114). Modifies the `⁠a, a > code⁠` elements. The value of this variable is also stored as a CSS variable that can be referenced with `var(--link-color)` in any argument of a style function or in custom CSS.
`text_bold_color`	Bold Text Color. Defaults to `NULL`. Modifies the `strong` element. The value of this variable is also stored as a CSS variable that can be referenced with `var(--text-bold-color)` in any argument of a style function or in custom CSS.
`text_slide_number_color`	Slide Number Color. Defaults to `inverse_background_color`. Modifies the `.remark-slide-number` class.
`padding`	Slide Padding in `⁠top right [bottom left]⁠` format. Defaults to 16px 64px 16px 64px. Modifies the `.remark-slide-content` class. Accepts CSS padding property values.
`background_image`	Background image applied to each and every slide. Set `title_slide_background_image = "none"` to remove the background image from the title slide. Defaults to `NULL`. Modifies the `.remark-slide-content` class.
`background_size`	Background image size, requires `background_image` to be set. If `background_image` is set, `background_size` will default to `cover` so the background fills the screen. If both `background_image` and `background_position` are set, will default to 100 percent. Defaults to `NULL`. Modifies the `.remark-slide-content` class. Accepts CSS background-size property values.
`background_position`	Background image position, requires `background_image` to be set, and it is recommended to adjust `background_size`. Defaults to `NULL`. Modifies the `.remark-slide-content` class. Accepts CSS background-position property values.
`code_highlight_color`	Code Line Highlight. Defaults to rgba(255,255,0,0.5). Modifies the `.remark-code-line-highlighted` class. The value of this variable is also stored as a CSS variable that can be referenced with `var(--code-highlight-color)` in any argument of a style function or in custom CSS.
`code_inline_color`	Inline Code Color. Defaults to #000. Modifies the `.remark-inline-code` class.
`code_inline_background_color`	Inline Code Background Color. Defaults to `NULL`. Modifies the `.remark-inline-code` class.
`code_inline_font_size`	Inline Code Text Font Size. Defaults to 1em. Modifies the `.remark-inline-code` class. Accepts CSS font-size property values. The value of this variable is also stored as a CSS variable that can be referenced with `var(--code-inline-font-size)` in any argument of a style function or in custom CSS.
`inverse_background_color`	Inverse Background Color. Defaults to #272822. Modifies the `.inverse` class. The value of this variable is also stored as a CSS variable that can be referenced with `var(--inverse-background-color)` in any argument of a style function or in custom CSS.
`inverse_text_color`	Inverse Text Color. Defaults to #d6d6d6. Modifies the `.inverse` class. The value of this variable is also stored as a CSS variable that can be referenced with `var(--inverse-text-color)` in any argument of a style function or in custom CSS.
`inverse_text_shadow`	Enables Shadow on text of inverse slides. Defaults to `FALSE`. Modifies the `.inverse` class.
`inverse_header_color`	Inverse Header Color. Defaults to #f3f3f3. Modifies the `⁠.inverse h1, .inverse h2, .inverse h3⁠` classes. The value of this variable is also stored as a CSS variable that can be referenced with `var(--inverse-header-color)` in any argument of a style function or in custom CSS.
`inverse_link_color`	Inverse Link Color. Defaults to `link_color`. Modifies the `⁠.inverse a, .inverse a > code⁠` classes. The value of this variable is also stored as a CSS variable that can be referenced with `var(--inverse-link-color)` in any argument of a style function or in custom CSS.
`title_slide_text_color`	Title Slide Text Color. Defaults to `inverse_text_color`. Modifies the `.title-slide` class. The value of this variable is also stored as a CSS variable that can be referenced with `var(--title-slide-text-color)` in any argument of a style function or in custom CSS.
`title_slide_background_color`	Title Slide Background Color. Defaults to `inverse_background_color`. Modifies the `.title-slide` class. The value of this variable is also stored as a CSS variable that can be referenced with `var(--title-slide-background-color)` in any argument of a style function or in custom CSS.
`title_slide_background_image`	Title Slide Background Image URL. Defaults to `NULL`. Modifies the `.title-slide` class.
`title_slide_background_size`	Title Slide Background Image Size, defaults to "cover" if background image is set. Defaults to `NULL`. Modifies the `.title-slide` class. Accepts CSS background-size property values.
`title_slide_background_position`	Title Slide Background Image Position. Defaults to `NULL`. Modifies the `.title-slide` class. Accepts CSS background-position property values.
`footnote_color`	Footnote text color (if `NA`, then it will be the same color as `text_color`). Defaults to `NULL`. Modifies the `.footnote` class.
`footnote_font_size`	Footnote font size. Defaults to 0.9em. Modifies the `.footnote` class. Accepts CSS font-size property values.
`footnote_position_bottom`	Footnote location from bottom of screen. Defaults to 60px. Modifies the `.footnote` class. Accepts CSS position property values.
`left_column_subtle_color`	Left Column Text (not last). Defaults to #777. Modifies the `⁠.left-column h2, .left-column h3⁠` classes.
`left_column_selected_color`	Left Column Current Selection. Defaults to #000. Modifies the `⁠.left-column h2:last-of-type, .left-column h3:last-child⁠` classes.
`blockquote_left_border_color`	Blockquote Left Border Color. Defaults to lightgray. Modifies the `blockquote` element.
`table_border_color`	Table top/bottom border. Defaults to #666. Modifies the `⁠table: border-top, border-bottom⁠` elements.
`table_row_border_color`	Table row inner bottom border. Defaults to #ddd. Modifies the `⁠table thead th: border-bottom⁠` elements.
`table_row_even_background_color`	Table Even Row Background Color. Defaults to #eee. Modifies the `⁠thead, tfoot, tr:nth-child(even)⁠` elements.
`base_font_size`	Base Font Size for All Slide Elements (must be `px`). Defaults to 20px. Modifies the `html` element. The value of this variable is also stored as a CSS variable that can be referenced with `var(--base-font-size)` in any argument of a style function or in custom CSS.
`text_font_size`	Slide Body Text Font Size. Defaults to 1rem. Modifies the `.remark-slide-content` class. Accepts CSS font-size property values. The value of this variable is also stored as a CSS variable that can be referenced with `var(--text-font-size)` in any argument of a style function or in custom CSS.
`header_h1_font_size`	h1 Header Text Font Size. Defaults to 2.75rem. Modifies the `⁠.remark-slide-content h1⁠` class. Accepts CSS font-size property values. The value of this variable is also stored as a CSS variable that can be referenced with `var(--header-h1-font-size)` in any argument of a style function or in custom CSS.
`header_h2_font_size`	h2 Header Text Font Size. Defaults to 2.25rem. Modifies the `⁠.remark-slide-content h2⁠` class. Accepts CSS font-size property values. The value of this variable is also stored as a CSS variable that can be referenced with `var(--header-h2-font-size)` in any argument of a style function or in custom CSS.
`header_h3_font_size`	h3 Header Text Font Size. Defaults to 1.75rem. Modifies the `⁠.remark-slide-content h3⁠` class. Accepts CSS font-size property values. The value of this variable is also stored as a CSS variable that can be referenced with `var(--header-h3-font-size)` in any argument of a style function or in custom CSS.
`header_background_auto`	Add background under slide title automatically for h1 header elements. If not enabled, use `class: header_background` to enable. Defaults to `FALSE`.
`header_background_color`	Background Color for h1 Header with Background. Defaults to `header_color`. Modifies the `⁠.remark-slide-content h1⁠` class. The value of this variable is also stored as a CSS variable that can be referenced with `var(--header-background-color)` in any argument of a style function or in custom CSS.
`header_background_text_color`	Text Color for h1 Header with Background. Defaults to `background_color`. Modifies the `⁠.remark-slide-content h1⁠` class. The value of this variable is also stored as a CSS variable that can be referenced with `var(--header-background-text-color)` in any argument of a style function or in custom CSS.
`header_background_padding`	Padding for h1 Header with Background. Defaults to `NULL`. Modifies the `⁠.remark-slide-content h1⁠` class. Accepts CSS padding property values.
`header_background_content_padding_top`	Top Padding for Content in Slide with Header with Background. Defaults to 7rem. Modifies the `.remark-slide-content` class.
`header_background_ignore_classes`	Slide Classes Where Header with Background will not be Applied. Defaults to `c('normal', 'inverse', 'title', 'middle', 'bottom')`. Modifies the `.remark-slide-content` class.
`text_slide_number_font_size`	Slide Number Text Font Size. Defaults to 0.9rem. Modifies the `.remark-slide-number` class. Accepts CSS font-size property values.
`text_font_google`	Use `google_font()` to specify body font. Defaults to `NULL`. Modifies the `body` element.
`text_font_family`	Body Text Font Family (xaringan default is `'Droid Serif'`). Defaults to `xaringanthemer_font_default("text_font_family")`. Modifies the `body` element. The value of this variable is also stored as a CSS variable that can be referenced with `var(--text-font-family)` in any argument of a style function or in custom CSS.
`text_font_weight`	Body Text Font Weight. Defaults to `xaringanthemer_font_default("text_font_weight")`. Modifies the `body` element. Accepts CSS font-weight property values.
`text_bold_font_weight`	Body Bold Text Font Weight. Defaults to bold. Modifies the `strong` element.
`text_font_url`	Body Text Font URL(s). Defaults to `xaringanthemer_font_default("text_font_url")`. Modifies the `⁠@import url()⁠` elements.
`text_font_family_fallback`	Body Text Font Fallbacks. Defaults to `xaringanthemer_font_default("text_font_family_fallback")`. Modifies the `body` element. The value of this variable is also stored as a CSS variable that can be referenced with `var(--text-font-family-fallback)` in any argument of a style function or in custom CSS.
`text_font_base`	Body Text Base Font (Total Failure Fallback). Defaults to sans-serif. Modifies the `body` element. The value of this variable is also stored as a CSS variable that can be referenced with `var(--text-font-base)` in any argument of a style function or in custom CSS.
`header_font_google`	Use `google_font()` to specify header font. Defaults to `NULL`. Modifies the `body` element.
`header_font_family`	Header Font Family (xaringan default is `'Yanone Kaffeesatz'`). Defaults to `xaringanthemer_font_default("header_font_family")`. Modifies the `⁠h1, h2, h3⁠` elements. The value of this variable is also stored as a CSS variable that can be referenced with `var(--header-font-family)` in any argument of a style function or in custom CSS.
`header_font_weight`	Header Font Weight. Defaults to `xaringanthemer_font_default("header_font_weight")`. Modifies the `⁠h1, h2, h3⁠` elements. Accepts CSS font-weight property values.
`header_font_family_fallback`	Header Font Family Fallback. Defaults to Georgia, serif. Modifies the `⁠h1, h2, h3⁠` elements. The value of this variable is also stored as a CSS variable that can be referenced with `var(--header-font-family-fallback)` in any argument of a style function or in custom CSS.
`header_font_url`	Header Font URL. Defaults to `xaringanthemer_font_default("header_font_url")`. Modifies the `⁠@import url⁠` elements.
`code_font_google`	Use `google_font()` to specify code font. Defaults to `NULL`. Modifies the `body` element.
`code_font_family`	Code Font Family. Defaults to `xaringanthemer_font_default("code_font_family")`. Modifies the `⁠.remark-code, .remark-inline-code⁠` classes. The value of this variable is also stored as a CSS variable that can be referenced with `var(--code-font-family)` in any argument of a style function or in custom CSS.
`code_font_size`	Code Text Font Size. Defaults to 0.9rem. Modifies the `.remark-inline` class. Accepts CSS font-size property values. The value of this variable is also stored as a CSS variable that can be referenced with `var(--code-font-size)` in any argument of a style function or in custom CSS.
`code_font_url`	Code Font URL. Defaults to `xaringanthemer_font_default("code_font_url")`. Modifies the `⁠@import url⁠` elements.
`code_font_family_fallback`	Code Font Fallback. Defaults to `xaringanthemer_font_default("code_font_family_fallback")`. Modifies the `⁠.remark-code, .remark-inline-code⁠` classes.
`link_decoration`	Text decoration of links. Defaults to none. Modifies the `⁠a, a > code⁠` elements. Accepts CSS text-decoration property values.
`colors`	A named vector of custom colors. The names of the colors become CSS variables and classes that can be used within your slides. For example, `colors = c(blue = "#bad4ed")` adds a CSS variable `--blue`, a `.blue` CSS class that applies the color to the text or foreground color, and a `.bg-blue` CSS class that applies the color to the background.
`extra_css`	A named list of CSS definitions each containing a named list of CSS property-value pairs, i.e. `list(".class-id" = list("css-property" = "value"))`.
`extra_fonts`	A list of additional fonts to import, each list element can be either a URL as a character string or a call to `google_font()`. To use a font imported in `extra_fonts`, you will need to write custom CSS rules that apply the font to an element or class with the `font-family` property. See the Fonts section of `vignette("xaringanthemer")` for an example.
`outfile`	Customized xaringan CSS output file name, default is "xaringan-themer.css"

Value

The CSS styles are written to the file path provided in outfile (by default to xaringan-themer.css). If outfile is NULL, the CSS is returned directly as a character string.

Functions

xaringanthemer_font_default(): Default values for font family, weight, URLs and font fallbacks.

Usage

To use the styles created by this theme function, make sure that you use xaringan-themer.css as your CSS file in your slides' YAML header. If you change the name of the output file using the outfile argument, use that name instead of the default file name.

output:
xaringan::moon_reader:
  css: xaringan-themer.css

Examples

# Create a xaringan style in a temporary file
xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

style_xaringan(
  text_color = "#002b3",
  inverse_background_color = "#31b09e",
  inverse_text_color = "#002b3",
  outfile = xaringan_themer_css # omit in your slides to write the
                                # styles to xaringan-themer.css
)

# View the CSS:
# file.edit(xaringan_themer_css)

[Package xaringanthemer version 0.4.2 Index]

Write A Customized Xaringan Theme

Description

Usage

Arguments

Value

Functions

Usage

See Also

Examples