use_vars_template: Use a template to define SCSS variables

View source: R/use_vars_template.R

use_vars_templateR Documentation

Use a template to define SCSS variables

Description

Open a SCSS template to modify variables, after use bs_vars_file to import those variables and create a theme.

Usage

use_vars_template(
  output_file,
  theme = c("default", "cerulean", "cosmo", "cyborg", "darkly", "flatly", "journal",
    "lumen", "paper", "readable", "sandstone", "simplex", "slate", "spacelab",
    "superhero", "united", "yeti"),
  open = interactive()
)

Arguments

output_file

Path where to create the template, use ".scss" as file extension.

theme

Base theme to use, e.g. "cosmo" to start modifying the cosmo theme.

open

Open the newly created file for editing? Happens in RStudio, if applicable, or via utils::file.edit() otherwise.

Note

After use bs_vars_file to use the template.

Examples

# For example, we use a temporary file
custom <- tempfile(fileext = ".scss")

# this will open a template
# to modify variables of the flatly theme
use_vars_template(
  output_file = custom,
  theme = "flatly"
)

# after use bs_vars_file() to use the template

# clean up
unlink(custom)

fresh documentation built on June 26, 2024, 5:06 p.m.