Merge pull request #1271 from ropensci/locale

add locale arg to config() which automatically adds relevant script, …

Author: cpsievert

NEWS.md

@@ -7,6 +7,7 @@
 * New "special arguments" `stroke`, `strokes`, `alpha_stroke`, `span`, and `spans` were added for easier control over the stroke (i.e., outline) appearance of various (filled) graphical marks. For an overview, see the **sf** blog post linked to in the bullet point above and the new package demos (list all demos with `demo(package = "plotly")`).
 * The selection (i.e., linked-brushing) mode can now switch from 'transient' to 'persistent' by holding the 'shift' key. It's still possible to _force_ persistent selection by setting `persistent = TRUE` in `highlight()`, but `persistent = FALSE` (the default) is now recommended since it allows one to switch between [persistent/transient selection](https://plotly-book.cpsievert.me/linking-views-without-shiny.html#transient-versus-persistent-selection) in the browser, rather than at the command line.
 * The new `partial_bundle()` function makes it easy to leverage [partial bundles of plotly.js](https://github.com/plotly/plotly.js#partial-bundles) for reduced file sizes and faster render times.
+* The `config()` function gains a `locale` argument for easily changing localization defaults (see #1270). This makes it possible localize date axes, and in some cases, modebar buttons (see #1270)
 * One may now inform `ggplotly()` about the relevant **shiny** output size via `session$clientData`. This ensures `ggplotly()` sizing is closer to **ggplot2** sizing, even on window resize. For an example, run `plotly_example("shiny", "ggplotly_sizing")`.
 * Instead of an error, `ggplotly(NULL, "message")` and `plotly_build(NULL, "message")` now returns `htmltools::div("message")`, making it easier to relay messages in shiny when data isn't yet ready to plot (see #1116)
 * The `animation_button()` function gains a `label` argument, making it easier to control the label of an animation button generated through the `frame` API (see #1205).

R/layout.R

@@ -90,14 +90,42 @@ rangeslider <- function(p, start = NULL, end = NULL, ...) {
 #' \url{https://github.com/plotly/plotly.js/blob/master/src/plot_api/plot_config.js}
 #' @param collaborate include the collaborate mode bar button (unique to the R pkg)?
 #' @param cloud include the send data to cloud button?
+#' @param locale locale to use. See [here](https://github.com/plotly/plotly.js/tree/master/dist#to-include-localization) for more info.
 #' @author Carson Sievert
 #' @export
 #' @examples
 #' 
-#' config(plot_ly(), displaylogo = FALSE, collaborate = FALSE)
+#' today <- Sys.Date()
+#' x <- seq.Date(today, today + 360, by = "day")
+#' p <- plot_ly(x = x, y = rnorm(length(x))) %>%
+#'   add_lines()
+#' 
+#' # remove the plotly logo and collaborate button from modebar
+#' config(p, displaylogo = FALSE, collaborate = FALSE)
+#' 
+#' # japanese
+#' config(p, locale = "ja")
+#' # german
+#' config(p, locale = "de")
+#' # swiss-german
+#' config(p, locale = "de-CH")
+#' # spanish
+#' config(p, locale = "es")
+#' # french
+#' config(p, locale = "fr")
+#' # chinese
+#' config(p, locale = "zh-CN")
 #' 
 
-config <- function(p, ..., collaborate = TRUE, cloud = FALSE) {
+config <- function(p, ..., collaborate = TRUE, cloud = FALSE, locale = NULL) {
+  
+  if (!is.null(locale)) {
+    p$dependencies <- c(
+      p$dependencies,
+      list(locale_dependency(locale))
+    )
+    p$x$config$locale <- locale
+  }
 
   p$x$config <- modify_list(p$x$config, list(...))
 

R/plotly.R

@@ -440,6 +440,41 @@ plotlyHtmlwidgetsCSS <- function() {
   )
 }
 
+locale_dependency <- function(locale) {
+  if (!is.character(locale) || length(locale) != 1) {
+    stop("locale must be a character string (vector of length 1)", call. = FALSE)
+  }
+  
+  locale_dir <- depPath("plotlyjs", "locales")
+  locales_all <- sub("\\.js$", "", list.files(locale_dir))
+  if (!tolower(locale) %in% locales_all) {
+    stop(
+      "Invalid locale: '", locale, "'.\n\n",
+      sprintf("Supported locales include: '%s'", paste(locales_all, collapse = "', '")),
+      call. = FALSE
+    )
+  }
+  
+  
+  # some locales rely on a base/main locale (e.g. de-CH relies on de)
+  # https://codepen.io/etpinard/pen/pKvLVX?editors=1010
+  scripts <- paste0(locale, ".js")
+  if (grepl("-", locale)) {
+    locale_main <- strsplit(locale, "-")[[1]][1]
+    if (locale_main %in% locales_all) {
+      scripts <- c(scripts, paste0(locale_main, ".js"))
+    }
+  }
+  
+  htmltools::htmlDependency(
+    name = paste0("plotly-locale-", locale),
+    version = plotlyMainBundle()$version,
+    src = list(file = locale_dir),
+    script = scripts,
+    all_files = FALSE
+  )
+}
+
 #' Remove TypedArray polyfill
 #'
 #' By default, plotly.js' TypedArray polyfill is included as a dependency, so