bs_global_theme()
creates a new (global) Bootstrap Sass theme which
bs_theme_dependencies()
(or sass_partial()
) can consume (their theme
argument defaults to bs_global_get()
, which get the current global theme).
Usage
bs_global_theme(
version = version_default(),
bootswatch = NULL,
bg = NULL,
fg = NULL,
primary = NULL,
secondary = NULL,
success = NULL,
info = NULL,
warning = NULL,
danger = NULL,
base_font = NULL,
code_font = NULL,
heading_font = NULL,
...
)
bs_global_set(theme = bs_theme())
bs_global_get()
bs_global_clear()
bs_global_add_variables(
...,
.where = "defaults",
.default_flag = identical(.where, "defaults")
)
bs_global_add_rules(...)
bs_global_bundle(...)
bs_global_theme_update(
...,
bootswatch = NULL,
bg = NULL,
fg = NULL,
primary = NULL,
secondary = NULL,
success = NULL,
info = NULL,
warning = NULL,
danger = NULL,
base_font = NULL,
code_font = NULL,
heading_font = NULL
)
Arguments
- version
The major version of Bootstrap to use (see
versions()
for possible values). Defaults to the currently recommended version for new projects (currently Bootstrap 5).- bootswatch
The name of a bootswatch theme (see
bootswatch_themes()
for possible values). When provided tobs_theme_update()
, any previous Bootswatch theme is first removed before the new one is applied (usebootswatch = "default"
to effectively remove the Bootswatch theme).- bg
A color string for the background.
- fg
A color string for the foreground.
- primary
A color to be used for hyperlinks, to indicate primary/default actions, and to show active selection state in some Bootstrap components. Generally a bold, saturated color that contrasts with the theme's base colors.
- secondary
A color for components and messages that don't need to stand out. (Not supported in Bootstrap 3.)
- success
A color for messages that indicate an operation has succeeded. Typically green.
- info
A color for messages that are informative but not critical. Typically a shade of blue-green.
- warning
A color for warning messages. Typically yellow.
- danger
A color for errors. Typically red.
- base_font
The default typeface.
- code_font
The typeface to be used for code. Be sure this is monospace!
- heading_font
The typeface to be used for heading elements.
- ...
arguments passed along to
bs_add_variables()
.- theme
a
bs_theme()
object.- .where
Whether to place the variable definitions before other Sass
"defaults"
, after other Sass"declarations"
, or after other Sass"rules"
.- .default_flag
Whether or not to add a
!default
flag (if missing) to variable expressions. It's recommended to keep this asTRUE
when.where = "defaults"
.
Value
functions that modify the global theme (e.g., bs_global_set()
)
invisibly return the previously set theme. bs_global_get()
returns the
current global theme.
Examples
# Remember the global state now (so we can restore later)
theme <- bs_global_get()
# Use Bootstrap 3 (globally) with some theme customization
bs_global_theme(3, bg = "#444", fg = "#e4e4e4", primary = "#e39777")
if (interactive()) bs_theme_preview(with_themer = FALSE)
# If no global theme is active, bs_global_get() returns NULL
bs_global_clear()
bs_global_get()
#> NULL
# Restore the original state
bs_global_set(theme)