1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
|
#' @include utils.R
NULL
#' Preview a Bootstrap theme
#'
#' Launches an example shiny app that can be used to get a quick preview of a
#' [bs_theme()], as well as an interactive GUI for tweaking some of the
#' main theme settings. Calling `bs_theme_preview()` with no arguments starts
#' the theme preview app with the default theme, which is a great way to see
#' the available theme presets or to start creating your own theme.
#'
#' The app that this launches is subject to change as new features are
#' developed in \pkg{bslib} and \pkg{shiny}.
#'
#' @inheritParams bs_theme_update
#' @param ... passed along to [shiny::runApp()].
#' @param with_themer whether or not to run the app with [run_with_themer()].
#'
#' @return nothing, this function is called for its side-effects (launching an
#' application).
#'
#' @seealso Use [run_with_themer()] or [bs_themer()] to add the theming UI to
#' an existing shiny app.
#'
#' @examplesIf rlang::is_interactive()
#' theme <- bs_theme(bg = "#6c757d", fg = "white", primary = "orange")
#' bs_theme_preview(theme)
#'
#' @family Bootstrap theme functions
#' @export
bs_theme_preview <- function(theme = bs_theme(), ..., with_themer = TRUE) {
assert_bs_theme(theme)
old_theme <- bs_global_get()
on.exit(bs_global_set(old_theme), add = TRUE)
bs_global_set(theme)
# TODO: add more this demo and also an option for launching different demos
app <- system_file("themer-demo", package = "bslib")
if (with_themer) {
run_with_themer(app, ...)
} else {
shiny::runApp(app, ...)
}
}
colorpicker_deps <- function() {
htmltools::htmlDependency(
"bootstrap-colorpicker",
"3.1.2",
path_lib("bs-colorpicker"),
stylesheet = "css/bootstrap-colorpicker.min.css",
script = "js/bootstrap-colorpicker.js"
)
}
opts_metadata <- function(theme) {
opts <- jsonlite::fromJSON(
system_file("themer/options.json", package = "bslib"),
simplifyDataFrame = FALSE
)
version <- theme_version(theme)
themes <- list(
"Bootstrap" = "bootstrap",
"bslib" = builtin_themes(version),
"Bootswatch" = bootswatch_themes(version)
)
opts[[1]]$preset$choices <- dropNulls(themes)
opts
}
bs_themer_ui <- function(opts, vals, theme) {
theme_v <- theme_version(theme)
make_control <- function(id, opts) {
if (!is.null(opts$version)) {
if (!is.null(opts$version$min) && theme_v < opts$version$min) {
return(NULL)
}
if (!is.null(opts$version$max) && theme_v > opts$version$max) {
return(NULL)
}
}
value <- vals[[id]]
lbl <- HTML(opts$label)
desc <- HTML(opts$desc)
text_input <- function(input_class = NULL, type = "text", ...) {
div(
class = "form-row form-group",
tags$label(lbl),
tags$input(
type = type,
value = value,
"data-id" = id,
class = "form-control form-control-sm bs-theme-value",
class = input_class,
...
),
if (!is.null(desc)) div(class = "form-text small", desc)
)
}
switch_input <- function(input_class = NULL, ...) {
# https://getbootstrap.com/docs/5.3/forms/checks-radios/#switches
div(
class = "form-row form-group form-check form-switch",
tags$label(
class = "form-check-label",
tags$input(
class = "form-check-input",
class = input_class,
type = "checkbox",
role = "switch",
id = paste0("bsthemer-", id)
),
lbl
)
)
}
switch(
opts$type,
color = text_input(input_class = "bs-theme-value-color text-monospace"),
str = text_input(input_class = "bs-theme-value-str"),
length = text_input(input_class = "bs-theme-value-length"),
number = text_input(
input_class = "bs-theme-value-str",
type = "number",
step = opts$step
),
bool = tagList(
div(
class = "form-check",
tags$input(
type = "checkbox",
checked = if (value) NA else NULL,
class = "bs-theme-value bs-theme-value-bool form-check-input",
id = paste0(".bsthemer-", id),
"data-id" = id
),
tags$label(
"for" = paste0(".bsthemer-", id),
class = "form-check-label",
lbl
)
),
if (!is.null(desc)) div(class = "form-text small", desc)
),
switch = switch_input(),
select = div(
class = "form-row form-group",
tags$label(class = "control-label", lbl),
tags$select(
class = "form-control",
"data-id" = id,
class = "bs-theme-value bs-theme-value-select",
# This select is designed for the 'bootswatch' input and assumes that
# the choices options are a list of lists, each list is an optgroup.
lapply(seq_along(opts$choices), function(idx) {
group_name <- names(opts$choices)[[idx]]
choice_group <- opts$choices[[idx]]
opts <- lapply(choice_group, function(x) {
tags$option(
value = x,
selected = if (identical(x, value)) NA else NULL,
tools::toTitleCase(x)
)
})
if (!nzchar(group_name)) return(opts)
tags$optgroup(label = group_name, opts)
})
),
if (!is.null(desc)) div(class = "form-text small", desc)
),
stop("unknown type")
)
}
version <- theme_version(theme)
accordion <- lapply(seq_along(opts), function(i) {
opt_name <- names(opts)[[i]]
elId <- paste0("bsthemerCollapse", i)
btn <- tags$button(
class = if (version >= 5) "accordion-button" else
"btn btn-link px-3 py-2 w-100 text-left border-0",
class = if (i != 1) "collapsed",
"data-toggle" = "collapse",
"data-target" = paste0("#", elId),
# data-bs-* is for BS5+
"data-bs-toggle" = "collapse",
"data-bs-target" = paste0("#", elId),
"aria-expanded" = "true",
"aria-controls" = elId,
opt_name
)
controls <- lapply(seq_along(opts[[i]]), function(j) {
make_control(names(opts[[i]])[[j]], opts[[i]][[j]])
})
div(
class = if (version >= 5) "accordion-item",
div(
class = if (version >= 5) "accordion-header" else
"card-header p-0 border-0",
btn
),
div(
id = elId,
class = if (i == 1) "show" else "collapse",
"data-parent" = "#bsthemerAccordion",
# data-bs-* is for BS5+
"data-bs-parent" = "#bsthemerAccordion",
class = if (version >= 5) "accordion-collapse",
div(
class = if (version >= 5) "accordion-body" else "card-body",
controls
)
)
)
})
withTags(
tagList(
colorpicker_deps(),
htmlDependency(
"bs_themer",
version = get_package_version("bslib"),
src = "themer",
script = c("themer.js"),
package = "bslib",
all_files = FALSE
),
div(
id = "bsthemerContainer",
class = "card shadow",
style = css(
# The bootstrap-colorpicker plugin sets a z-index of 1060 on
# it's inputs, so the container needs a smaller index, than that
# https://github.com/rstudio/bslib/blob/e4da71f3/inst/lib/bs-colorpicker/css/bootstrap-colorpicker.css#L38
#
# It's also important that this z-index is higher than 1030 so it's
# overlaid on-top of fixed/sticky navbars
# https://github.com/rstudio/bslib/blob/e4da71f3/inst/lib/bs/scss/_variables.scss#L697-L701
z_index = 1059,
width = "18rem",
max_height = "80vh",
position = "fixed",
top = "1rem",
right = "1rem",
height = "auto"
),
div(
id = "bsthemerHeader",
class = "move-grabber",
"data-target" = "#bsthemerContainer",
class = "card-header font-weight-bold bg-dark text-light px-3 py-2",
"Theme customizer",
tags$div(
id = "bsthemerToggle",
class = "float-right",
"data-toggle" = "collapse",
"data-target" = "#bsthemerAccordion",
# data-bs-* is for BS5+
"data-bs-toggle" = "collapse",
"data-bs-target" = "#bsthemerAccordion",
style = css(cursor = "pointer"),
tags$span(),
bs_dependency_defer(themer_css_dependency)
)
),
div(
id = "bsthemerAccordion",
class = "collapse show",
class = if (version >= 5) "accordion",
style = css(overflow_y = "auto"),
accordion
)
)
)
)
}
themer_css_dependency <- function(theme) {
version <- get_package_version("bslib")
bs_dependency(
input = sass_file(system_file("themer/themer.scss", package = "bslib")),
theme = theme,
name = "bs-themer-css",
version = version,
cache_key_extra = version
)
}
#' Theme customization UI
#'
#' A 'real-time' theme customization UI that you can use to easily make common
#' tweaks to Bootstrap variables and immediately see how they would affect your
#' app's appearance. There are two ways you can launch the theming UI. For most
#' Shiny apps, just use `run_with_themer()` in place of [shiny::runApp()]; they
#' should take the same arguments and work the same way. Alternatively, you can
#' call the `bs_themer()` function from inside your server function (or in an R
#' Markdown app that is using `runtime: shiny`, you can call this from any code
#' chunk). Note that this function is only intended to be used for development!
#'
#' To help you utilize the changes you see in the preview, this utility prints
#' [bs_theme()] code to the R console.
#'
#' @param appDir The application to run. This can be a file or directory path,
#' or a [shiny::shinyApp()] object. See [shiny::runApp()] for details.
#' @param ... Additional parameters to pass through to [shiny::runApp()].
#' @param gfonts whether or not to detect Google Fonts and wrap them in
#' [font_google()] (so that their font files are automatically imported).
#' @param gfonts_update whether or not to update the internal database of
#' Google Fonts.
#'
#' @section Limitations:
#'
#' * Doesn't work with Bootstrap 3.
#' * Doesn't work with IE11.
#' * Only works inside Shiny apps and `runtime: shiny` R Markdown documents.
#' * Can't be used with static R Markdown documents.
#' * Can be used to some extent with `runtime: shiny_prerendered`, but only UI
#' rendered through a `context="server"` may update in real-time.
#' * Doesn't work with '3rd party' custom widgets that don't make use of
#' [bs_dependency_defer()] or [bs_current_theme()].
#'
#' @return nothing. These functions are called for their side-effects.
#'
#' @examples
#' library(shiny)
#'
#' ui <- fluidPage(
#' theme = bs_theme(bg = "black", fg = "white"),
#' h1("Heading 1"),
#' h2("Heading 2"),
#' p(
#' "Paragraph text;",
#' tags$a(href = "https://www.rstudio.com", "a link")
#' ),
#' p(
#' actionButton("cancel", "Cancel"),
#' actionButton("continue", "Continue", class = "btn-primary")
#' ),
#' tabsetPanel(
#' tabPanel("First tab",
#' "The contents of the first tab"
#' ),
#' tabPanel("Second tab",
#' "The contents of the second tab"
#' )
#' )
#' )
#'
#' if (interactive()) {
#' run_with_themer(shinyApp(ui, function(input, output) {}))
#' }
#'
#' @export
run_with_themer <- function(
appDir = getwd(),
...,
gfonts = TRUE,
gfonts_update = FALSE
) {
shiny::runApp(
as_themer_app(appDir, gfonts = gfonts, gfonts_update = gfonts_update),
...
)
}
as_themer_app <- function(appDir, gfonts = TRUE, gfonts_update = FALSE) {
obj <- shiny::as.shiny.appobj(appDir)
origServerFuncSource <- obj[["serverFuncSource"]]
obj[["serverFuncSource"]] <- function() {
origServerFunc <- origServerFuncSource()
function(input, output, session, ...) {
bs_themer(gfonts, gfonts_update)
if (!"session" %in% names(formals(origServerFunc))) {
origServerFunc(input, output, ...)
} else {
origServerFunc(input, output, session, ...)
}
}
}
obj
}
#' @rdname run_with_themer
#' @export
bs_themer <- function(gfonts = TRUE, gfonts_update = FALSE) {
session <- get_current_session()
if (!identical("ok", session$ns("ok"))) {
stop(
call. = FALSE,
"`bslib::bs_themer()` must be called from within a ",
"top-level Shiny server function, not a Shiny module server function"
)
}
if (!is_installed("shiny", "1.6.0")) {
stop(call. = FALSE, "`bslib::bs_themer()` requires shiny v1.6.0 or higher")
}
theme <- get_current_theme()
if (!is_bs_theme(theme)) {
stop(
call. = FALSE,
"`bslib::bs_themer()` requires `shiny::bootstrapLib()` to be present ",
"in the app's UI. Consider providing `bslib::bs_theme()` to the theme argument of the ",
"relevant page layout function (or, more generally, adding `bootstrapLib(bs_theme())` to the UI."
)
}
preset_initial <- theme_preset_info(theme)$name
switch_version(
theme,
three = stop("Interactive theming for Bootstrap 3 isn't supported")
)
if (isTRUE(session$userData[["bs_themer_init"]])) {
# bs_themer() was called multiple times for the same session
return()
} else {
session$userData[["bs_themer_init"]] <- TRUE
}
gfont_info <- if (isTRUE(gfonts)) get_gfont_info(gfonts_update)
# Insert the theming control panel with values informed by the theme settings
themer_opts <- opts_metadata(theme)
themer_vars <- unlist(unname(lapply(themer_opts, names)))
sass_vars <- setdiff(themer_vars, c("preset", "dark-mode"))
themer_vals <- as.list(get_themer_vals(theme, sass_vars))
themer_vals$preset <- preset_initial
shiny::insertUI(
"body",
where = "beforeEnd",
ui = bs_themer_ui(themer_opts, themer_vals, theme)
)
input <- session$input
# We emit different 'code' for runtime:shiny in Rmd
isRmd <- is_shiny_runtime()
# When the bootswatch theme changes, update the themer's state to reflect
# the new variable defaults. Note that we also update the "input theme",
# and effectively throw out any other theming changes made (i.e., start from a new theme)
# since it'd be messy to figure out whether changes are "real" or just a
# consequence of a new bootswatch value
shiny::observeEvent(input$bs_theme_preset, {
theme <<- set_current_theme(
theme,
list(preset = input$bs_theme_preset),
session,
rmd = isRmd
)
vals <- as.list(bs_get_variables(theme, sass_vars))
session$sendCustomMessage("bs-themer-preset", list(values = vals))
})
# Fires when anything other then the Bootswatch theme changes
shiny::observeEvent(input$bs_theme_vars, {
vals <- jsonlite::parse_json(input$bs_theme_vars)
# Validate that `vals` is a simple list, containing atomic elements,
# that are all named
if (
!identical(class(vals), "list") ||
!all(
vapply(
vals,
function(x) {
is.atomic(x) || is.null(x)
},
logical(1)
)
) ||
is.null(names(vals)) ||
!isTRUE(all(nzchar(names(vals), keepNA = TRUE)))
) {
warning(
call. = FALSE,
"bs_themer() encountered malformed input; ignoring"
)
return()
}
# Makes remaining logic simpler to reason about
if (length(vals) == 0) {
return()
}
# Remember, theme at this point has been updated to reflect the current Bootswatch theme,
# so re-query Sass values from the (possibly updated) theme, then filter down to meaningful
# differences
theme_vals <- get_themer_vals(theme, names(vals[sass_vars]))
changed_vals <- as.list(diff_css_values(vals[sass_vars], theme_vals))
if (!identical(preset_initial, input$bs_theme_preset)) {
changed_vals$preset <- input$bs_theme_preset
}
# If _either_ fg/bg has changed, bs_theme() must to be called with *both* fg and bg populated.
if (any(c("bg", "fg") %in% names(changed_vals))) {
changed_vals[["bg"]] <- changed_vals[["bg"]] %||% vals[["bg"]]
changed_vals[["fg"]] <- changed_vals[["fg"]] %||% vals[["fg"]]
}
# Change variables names to their 'high-level' equivalents
changed_vals <- rename2(
changed_vals,
"font-family-base" = "base_font",
"font-family-monospace" = "code_font",
"headings-font-family" = "heading_font",
"font-size-base" = "font_scale"
)
if (length(changed_vals$font_scale)) {
changed_vals$font_scale <- as.numeric(changed_vals$font_scale)
}
if (isTRUE(gfonts)) {
for (var in c("base_font", "code_font", "heading_font")) {
changed_vals[[var]] <- insert_font_google_call(
changed_vals[[var]],
gfont_info
)
}
}
set_current_theme(theme, changed_vals, session, rmd = isRmd)
})
}
get_themer_vals <- function(theme, vars) {
vals <- bs_get_variables(theme, vars)
if (!grepl("rem$", vals[["font-size-base"]])) {
stop(
"font-size-base must have a CSS unit length type of rem",
call. = FALSE
)
}
vals[["font-size-base"]] <- sub("rem$", "", vals[["font-size-base"]])
vals
}
set_current_theme <- function(theme, changed_vals, session, rmd = FALSE) {
shiny::insertUI(
"body",
ui = spinner_overlay(),
immediate = TRUE,
session = session
)
on.exit(shiny::removeUI("body > #spinner_overlay"), add = TRUE)
# Construct the code/yaml to display to the user
if (isTRUE(rmd)) {
display_vals <- lapply(changed_vals, function(x) {
if (is.numeric(x)) {
return(x)
}
if (rlang::is_call(x)) {
str <- paste0(deparse(x, width.cutoff = 500L), collapse = "")
return(paste("!expr", str))
}
# To avoid yaml parse errors with values that contain # or ",
# first escape ", then in quote the value
paste0('"', gsub('"', '\\"', x, fixed = TRUE), '"')
})
message("\n#### Update your Rmd output format's theme: ####")
cat(
paste0(
" theme:\n",
paste0(
collapse = "\n",
" ",
names(display_vals),
": ",
display_vals
),
"\n"
)
)
} else {
message("\n#### Update your bs_theme() R code with: #####")
print(rlang::expr(bs_theme_update(theme, !!!changed_vals)))
}
# Color contrast warnings are more annoying then they are useful inside the theming widget
opts <- options(bslib.color_contrast_warnings = FALSE)
on.exit(options(opts), add = TRUE)
# the actual code that we evaluate should not have quoted expressions
changed_vals[] <- lapply(changed_vals, eval_val)
code <- rlang::expr(bs_theme_update(theme, !!!changed_vals))
theme <- rlang::eval_tidy(code)
# Prevent Sass compilation errors from crashing the app and relay a message to user.
# Errors can happen if the users enters values that lead to unexpected Sass
# expressions (e.g., "$foo: * !default")
shiny::removeNotification("sass-compilation-error", session = session)
tryCatch(
session$setCurrentTheme(theme),
error = function(e) {
shiny::showNotification(
"Sass -> CSS compilation failed, likely due to invalid user input.
Other theming changes won't take effect until the invalid input is fixed.",
duration = NULL,
id = "sass-compilation-error",
type = "error",
session = session
)
}
)
invisible(theme)
}
spinner_overlay <- function() {
tagList(
tags$style(
"@supports ((-webkit-backdrop-filter:blur(4px)) or (backdrop-filter:blur(4px))) {
#spinner_overlay{ -webkit-backdrop-filter:blur(4px); backdrop-filter:blur(4px); background-color:rgba(255,255,255,.05);}
}"
),
div(
id = "spinner_overlay",
style = "position:absolute; top:0; left:0; min-height:100vh; width:100%; background-color:rgba(255,255,255,.8); z-index:100000",
class = "d-flex flex-column justify-content-center align-items-center",
div(
class = "spinner-border",
style = "width:5rem; height:5rem; color: rgba(0,0,0,0.8);",
role = "status",
span(class = "sr-only visually-hidden", "Refreshing stylesheets...")
),
span(
class = "lead mt-1",
style = "color: rgba(0,0,0,0.8);",
"Refreshing stylesheets..."
)
)
)
}
eval_val <- function(x) {
if (is.call(x)) return(eval(x))
if (!is.list(x)) return(x)
lapply(x, eval_val)
}
insert_font_google_call <- function(val, gfont_info) {
# val should be a non-empty character string
if (!is_string(val)) return(NULL)
if (!nzchar(val)) return(NULL)
fams <- strsplit(as.character(val), ",")[[1]]
fams <- vapply(
fams,
function(x) gsub("^\\s*['\"]?", "", gsub("['\"]?\\s*$", "", x)),
character(1),
USE.NAMES = FALSE
)
fams <- fams[nzchar(fams)]
is_a_gfont <- tolower(fams) %in% tolower(gfont_info$family)
if (length(fams) == 1) {
return(if (is_a_gfont) call("font_google", fams) else fams)
}
fams <- as.list(fams)
for (i in which(is_a_gfont)) {
fams[[i]] <- call("font_google", fams[[i]])
}
rlang::expr(font_collection(!!!unname(fams)))
}
get_gfont_info <- function(update = FALSE) {
if (isTRUE(update)) {
jsonlite::fromJSON(gfont_api_url())$items
} else {
# See tools/update_gfont_info.R
gfont_info
}
}
# same as thematic:::gfont_api_url
gfont_api_url <- function() {
paste0("https://www.googleapis.com/webfonts/v1/webfonts?key=", gfont_key())
}
# same as thematic:::gfont_key
# As mentioned in the developer API, this key is safe to be public facing
# https://developers.google.com/fonts/docs/developer_api
gfont_key <- function() {
Sys.getenv(
"GFONT_KEY",
paste0("AIzaSyDP", "KvElVqQ-", "26f7tjxyg", "IGpIajf", "tS_zmas")
)
}
#' Retrieve Sass variable values from the current theme
#'
#' Useful for retrieving a variable from the current theme and using
#' the value to inform another R function.
#'
#' @inheritParams bs_theme_update
#' @param varnames A character string referencing a Sass variable in the current
#' theme.
#'
#' @return Returns a character string containing a CSS/Sass value. If the
#' variable(s) are not defined, their value is `NA`.
#'
#' @references [Theming: Bootstrap 5 variables](https://rstudio.github.io/bslib/articles/bs5-variables/index.html)
#' provides a searchable reference of all theming variables available in
#' Bootstrap 5.
#'
#' @export
#' @family Bootstrap theme utility functions
#'
#' @examples
#' vars <- c("body-bg", "body-color", "primary", "border-radius")
#' bs_get_variables(bs_theme(), varnames = vars)
#' bs_get_variables(bs_theme(bootswatch = "darkly"), varnames = vars)
bs_get_variables <- function(theme, varnames) {
if (length(varnames) == 0) {
return(stats::setNames(character(0), character(0)))
}
# Our bg/fg are not actual Sass variables and can mean different things depending
# on the bootswatch theme/version
base_color_idx <- varnames %in% c("fg", "bg")
if (any(base_color_idx)) {
varnames[base_color_idx] <- rename2(
varnames[base_color_idx],
!!!get_base_color_map(theme)
)
}
assert_bs_theme(theme)
# Support both `bs_get_variables("$foo")` and `bs_get_variables("foo")`
# (note that `sass::sass("$$foo:1;")` is illegal; so this seems safe)
varnames <- sub("^\\$", "", varnames)
# It's possible that some varnames refer to variables that aren't defined.
# This would normally cause a crash. We define last-ditch defaults here,
# with a magic constant that we can swap out for NA before returning to
# the user.
na_sentinel <- "NA_SENTINEL_CONSTANT_4902F4E"
sassvars <- paste0(
"$",
varnames,
": ",
na_sentinel,
" !default;",
collapse = "\n"
)
# Declare a block with a meaningless but identifiable selector (.__rstudio_bslib_get_variables)
# and add properties for each variable that is desired.
cssvars <- paste0(
"--",
varnames,
": #{inspect($",
varnames,
")};",
collapse = "\n"
)
cssvars <- sprintf(":root.__rstudio_bslib_get_variables {\n %s \n}", cssvars)
css <- sass_partial(
cssvars,
# Add declarations to the current theme
bs_bundle(theme, sass_layer(mixins = sassvars)),
)
# Search the output for the block of properties we just generated, using the
# ".__rstudio_bslib_get_variables" selector. The capture group will include all of the
# properties we care about in a single string (the propstr variable below).
matches <- regexec(
"(:root)?\\.__rstudio_bslib_get_variables(:root)?\\s*\\{\\s*\\n(.*?)\\n\\s*\\}",
css
)
propstr <- regmatches(css, matches)[[1]][4]
if (is.na(propstr)) {
stop("bs_global_get_variables failed; expected selector was not found")
}
# Split the propstr by newline, so we can perform vectorized regex operations
# on all of the variables at once.
proplines <- strsplit(propstr, "\n")[[1]]
# Parse each line for the name and value.
matches2 <- regmatches(
proplines,
regexec("\\s*--([^:]+):\\s*(.*);$", proplines)
)
names <- vapply(matches2, function(x) x[2], character(1))
values <- vapply(matches2, function(x) x[3], character(1))
if (any(is.na(names))) {
stop(
"bs_global_get_variables failed; generated output was in an unexpected format"
)
}
if (!identical(varnames, names)) {
stop("bs_global_get_variables failed; expected properties were not found")
}
# Any variables that had to fall back to our defaults, we'll replace with NA
values[values == na_sentinel] <- NA_character_
if (any(base_color_idx)) {
varnames[base_color_idx] <- rename2(
varnames[base_color_idx],
!!!get_base_color_map(theme, decode = FALSE)
)
}
# Return as a named character vector
stats::setNames(values, varnames)
}
diff_css_values <- function(a, b) {
stopifnot(all(!is.na(a)))
stopifnot(identical(names(a), names(b)))
stopifnot(is.list(a))
if (!is.character(b)) browser()
a_char <- vapply(
a,
function(x) {
if (is.null(x) || isTRUE(is.na(x))) {
"null"
} else if (is.logical(x)) {
tolower(as.character(x))
} else if (is.character(x)) {
x
} else {
as.character(x)
}
},
character(1)
)
b <- ifelse(is.na(b), "null", b)
# Normalize colors; ignore things that don't seem to be colors. This is
# necessary so we don't consider "black", "#000", "#000000", "rgb(0,0,0,1)",
# etc. to be distinct values.
#
# Note: This won't work with values that are colors AND other things, like
# "solid #000 3px"; it needs the value to be solely a color to be normalized.
a_char_colors <- htmltools::parseCssColors(a_char, mustWork = FALSE)
a_char <- ifelse(!is.na(a_char_colors), a_char_colors, a_char)
b_colors <- htmltools::parseCssColors(b, mustWork = FALSE)
b <- ifelse(!is.na(b_colors), b_colors, b)
idx <- ifelse(is.na(b), TRUE, a_char != b)
a[idx]
}
#' @rdname bs_get_variables
#' @inheritParams bs_get_variables
#' @export
#' @examples
#'
#' bs_get_contrast(bs_theme(), c("primary", "dark", "light"))
#'
#' library(htmltools)
#' div(
#' class = "bg-primary",
#' style = css(
#' color = bs_get_contrast(bs_theme(), "primary")
#' )
#' )
#'
bs_get_contrast <- function(theme, varnames) {
stopifnot(is.character(varnames))
stopifnot(length(varnames) > 0)
varnames <- sub("^\\$", "", varnames)
prop_string <- paste0(
paste0(varnames, ": color-contrast($", varnames, ");"),
collapse = "\n"
)
css <- sass::sass_partial(
paste0("bs_get_contrast {", prop_string, "}"),
theme,
cache_key_extra = get_package_version("bslib"),
# Don't listen to global Sass options so we can be sure
# that stuff like source maps won't be included
options = sass::sass_options(source_map_embed = FALSE)
)
css <- gsub("\n", "", gsub("\\s*", "", css))
css <- sub("bs_get_contrast{", "", css, fixed = TRUE)
css <- sub("\\}$", "", css)
props <- strsplit(strsplit(css, ";")[[1]], ":")
setNames(
vapply(
props,
function(x) htmltools::parseCssColors(sub(";$", "", x[2])),
character(1)
),
vapply(props, `[[`, character(1), 1)
)
}
|