change: start using font_set

Author: davidgohel

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: ggiraph
 Title: Make 'ggplot2' Graphics Interactive
-Version: 0.9.5.006
+Version: 0.9.5.007
 Authors@R: c(
     person("David", "Gohel", , "david.gohel@ardata.fr", role = c("aut", "cre")),
     person("Panagiotis", "Skintzos", , "sigmapi@posteo.net", role = "aut"),
@@ -25,7 +25,7 @@ BugReports: https://github.com/davidgohel/ggiraph/issues
 Imports:
     cli,
     dplyr,
-    gdtools (>= 0.4.4),
+    gdtools (>= 0.5.0),
     ggplot2 (>= 4.0.0),
     grid,
     htmltools,

NAMESPACE

@@ -280,6 +280,7 @@ importFrom(dplyr,lag)
 importFrom(dplyr,mutate)
 importFrom(dplyr,ungroup)
 importFrom(gdtools,font_family_exists)
+importFrom(gdtools,font_set_liberation)
 importFrom(gdtools,sys_fonts)
 importFrom(grDevices,dev.cur)
 importFrom(grDevices,dev.list)

R/default.R

@@ -8,7 +8,7 @@ css_default_selection <- girafe_css_bicolor(
 )
 
 default_girafe_settings <- list(
-  fonts = default_fontname(),
+  fonts = validated_fonts(),
   opts_sizing = opts_sizing(width = 1),
   opts_tooltip = opts_tooltip(
     css = "padding:5px;background:black;color:white;border-radius:2px;text-align:left;",

R/dsvg.R

@@ -19,24 +19,13 @@
 #' @param desc A longer description for accessibility purposes (aria-description/aria-describedby).
 #' @param canvas_id svg id within HTML page.
 #' @param fonts Named list of font names to be aliased with
-#' fonts installed on your system. If unspecified, the R default
-#' families "sans", "serif", "mono" and "symbol"
-#' are aliased to the family returned by [match_family()].
-#'
-#' If fonts are available, the default mapping will use these values:
-#'
-#' | R family | Font on Windows    | Font on Unix | Font on Mac OS |
-#' |----------|--------------------|--------------|----------------|
-#' | `sans`   | Arial              | DejaVu Sans  | Helvetica      |
-#' | `serif`  | Times New Roman    | DejaVu serif | Times          |
-#' | `mono`   | Courier            | DejaVu mono  | Courier        |
-#' | `symbol` | Symbol             | DejaVu Sans  | Symbol         |
+#' fonts installed on your system. If unspecified, the defaults
+#' from [gdtools::font_set_liberation()] are used for the R families
+#' "sans", "serif", "mono" and "symbol".
 #'
 #' As an example, using `fonts = list(sans = "Roboto")` would make the
-#' default font "Roboto" as many ggplot theme are using `theme_minimal(base_family="")` or
-#' `theme_minimal(base_family="sans")`.
-#'
-#' You can also use theme_minimal(base_family="Roboto").
+#' default font "Roboto" as many ggplot themes use
+#' `theme_minimal(base_family = "sans")`.
 #' @seealso [Devices]
 #' @examples
 #' fileout <- tempfile(fileext = ".svg")

R/fonts.R

@@ -1,65 +1,35 @@
 r_font_families <- c("sans", "serif", "mono", "symbol")
-default_fonts <- list(
-  windows = c(
-    sans = "Arial",
-    serif = "Times New Roman",
-    mono = "Courier New",
-    symbol = "Symbol"
-  ),
-  osx = c(
-    sans = "Helvetica",
-    serif = "Times",
-    mono = "Courier",
-    symbol = "Symbol"
-  ),
-  unix = c(
-    sans = "DejaVu Sans",
-    serif = "DejaVu serif",
-    mono = "DejaVu mono",
-    symbol = "DejaVu Sans"
-  )
-)
-
-#' @importFrom gdtools font_family_exists
-default_fontname <- function() {
-  os <- get_os()
-  if (!os %in% c("windows", "osx")) {
-    os <- "unix"
-  }
-  def_fonts <- default_fonts[[os]]
-  def_fonts <- def_fonts[unlist(lapply(def_fonts, font_family_exists))]
-  missing_fonts <- setdiff(r_font_families, names(def_fonts))
-  def_fonts[missing_fonts] <- lapply(def_fonts[missing_fonts], match_family)
-  def_fonts
-}
 
 #' @export
 #' @title List of validated default fonts
 #' @description Validates and possibly modifies the fonts to be used as default
-#' value in a graphic according to the fonts available on the machine. It process
-#' elements named "sans", "serif", "mono" and "symbol".
-#' @param fonts Named list of font names to be aliased with
-#' fonts installed on your system. If unspecified, the R default
-#' families "sans", "serif", "mono" and "symbol"
-#' are aliased to the family returned by [match_family()].
+#' value in a graphic according to the fonts available on the machine. It
+#' processes elements named "sans", "serif", "mono" and "symbol".
 #'
-#' If fonts are available, the default mapping will use these values:
+#' Default font resolution is delegated to [gdtools::font_set_liberation()],
+#' which uses Liberation fonts (bundled by 'fontquiver', SIL Open Font
+#' License) for reproducible offline output.
 #'
-#' | R family | Font on Windows    | Font on Unix | Font on Mac OS |
-#' |----------|--------------------|--------------|----------------|
-#' | `sans`   | Arial              | DejaVu Sans  | Helvetica      |
-#' | `serif`  | Times New Roman    | DejaVu serif | Times          |
-#' | `mono`   | Courier            | DejaVu mono  | Courier        |
-#' | `symbol` | Symbol             | DejaVu Sans  | Symbol         |
+#' @param fonts Named list of font names to be aliased with
+#' fonts installed on your system. If unspecified, the defaults
+#' from [gdtools::font_set_liberation()] are used.
 #' @return a named list of validated font family names
 #' @seealso [girafe()], [dsvg()]
 #' @family functions for font management
+#' @importFrom gdtools font_family_exists font_set_liberation
 #' @examples
 #' validated_fonts()
 validated_fonts <- function(fonts = list()) {
+  auto <- font_set_liberation()
+  defaults <- c(
+    sans = auto$sans,
+    serif = auto$serif,
+    mono = auto$mono,
+    symbol = auto$symbol
+  )
   fonts <- fonts[unlist(lapply(fonts, font_family_exists))]
   missing_fonts <- setdiff(r_font_families, names(fonts))
-  fonts[missing_fonts] <- default_fontname()[missing_fonts]
+  fonts[missing_fonts] <- defaults[missing_fonts]
   fonts
 }
 

R/girafe.R

@@ -35,6 +35,18 @@
 #' @param pointsize the default pointsize of plotted text in pixels, default to 12.
 #' @param options a list of options for girafe rendering, see
 #' [opts_tooltip()], [opts_hover()], [opts_selection()], ...
+#' @param font_set A [gdtools::font_set()] object controlling font
+#' aliases and HTML dependencies. The default is
+#' [gdtools::font_set_liberation()], which uses Liberation fonts
+#' (bundled by 'fontquiver' under the SIL Open Font License).
+#' This makes output reproducible offline without requiring
+#' any system font.
+#'
+#' For system-aware font selection use [gdtools::font_set_auto()],
+#' or build a custom configuration with [gdtools::font_set()].
+#'
+#' `font_set$dsvg_fonts` is passed as `fonts` argument to [dsvg()] and
+#' `font_set$dependencies` are appended to `dependencies`.
 #' @param dependencies Additional widget HTML dependencies, see [htmlwidgets::createWidget()].
 #' @param check_fonts_registered whether to check if fonts families found in
 #' the ggplot are registered with 'systemfonts'.
@@ -97,7 +109,7 @@
 #' function `girafe`. Its value is beeing used to define a relative
 #' width of the graphic within its HTML container. Its height is automatically
 #' adjusted regarding to the argument `width` and the aspect ratio.
-#' @seealso [girafe_options()], [validated_fonts()], [dsvg()]
+#' @seealso [girafe_options()], [dsvg()], [gdtools::font_set()]
 #' @export
 girafe <- function(
   ggobj = NULL,
@@ -106,6 +118,7 @@ girafe <- function(
   width_svg = NULL,
   height_svg = NULL,
   options = list(),
+  font_set = NULL,
   dependencies = NULL,
   check_fonts_registered = FALSE,
   check_fonts_dependencies = FALSE,
@@ -136,6 +149,16 @@ girafe <- function(
     args$bg <- "#ffffff01"
   }
 
+  # font_set integration -----
+  if (is.null(font_set)) {
+    font_set <- font_set_liberation()
+  }
+  if (!inherits(font_set, "font_set")) {
+    cli::cli_abort("{.arg font_set} must be a {.cls font_set} object.")
+  }
+  args$fonts <- font_set$dsvg_fonts
+  dependencies <- c(dependencies, font_set$dependencies)
+
   if (!is.null(ggobj)) {
     # check ggobj -----
     if (!inherits(ggobj, "ggplot")) {

examples/girafe.R

@@ -2,7 +2,7 @@ library(ggplot2)
 library(ggiraph)
 library(gdtools)
 
-register_liberationsans()
+fonts <- font_set(sans = font_liberation("sans"))
 
 dataset <- mtcars
 dataset$carname <- row.names(mtcars)
@@ -18,13 +18,11 @@ gg_point <- ggplot(
   )
 ) +
   geom_point_interactive(hover_nearest = TRUE, size = 11 / .pt) +
-  theme_minimal(base_family = "Liberation Sans", base_size = 11)
+  theme_minimal(base_family = fonts$sans, base_size = 11)
 
 x <- girafe(
   ggobj = gg_point,
-  dependencies = list(
-    liberationsansHtmlDependency()
-  )
+  font_set = fonts
 )
 
 x

inst/tinytest/test-dsvg_text.R

@@ -82,7 +82,7 @@ source("setup.R")
 
 # test with font categories (sans, serif, mono, symbol) ----
 {
-  fonts <- ggiraph:::default_fontname()
+  fonts <- ggiraph::validated_fonts()
   for(name in names(fonts)) {
     if (gdtools::font_family_exists(fonts[[name]])) {
       doc <- dsvg_doc(