Add reportTheme argument to plotlyOutput() for reporting CSS styles (#1802)

cpsievert · web-flow · commit 36e2928904ee · 2020-06-26T11:16:23.000-05:00
* Add reportTheme argument to plotlyOutput() for reporting CSS styles

* update news, document, and add htmlwidgets to remotes
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -78,4 +78,6 @@ LazyData: true
 RoxygenNote: 7.1.0
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-Remotes: rstudio/thematic
+Remotes: 
+  rstudio/thematic,
+  ramnathv/htmlwidgets
diff --git a/NEWS.md b/NEWS.md
@@ -6,7 +6,7 @@
 
 ## NEW FEATURES
 
-* `ggplotly()` now works well with the [**thematic** package](https://rstudio.github.io/thematic). That is, it can now correctly translate **ggplot2** styling that derives from **thematic** (#1801).
+* `ggplotly()` now works well with the [**thematic** package](https://rstudio.github.io/thematic). That is, it can now correctly translate **ggplot2** styling that derives from **thematic**. Note that, in order to use **thematic**'s auto theming in Shiny with `ggplotly()`, you need **shiny** v1.5.0 (or higher) and **htmlwidgets** v1.5.1.9001 (or higher). Relatedly, if these versions are available, one may now also call `getCurrentOutputInfo()` inside `renderPlotly()` to get CSS styles of the output container (#1801 and #1802).
 
 ## IMPROVEMENTS
 
diff --git a/R/shiny.R b/R/shiny.R
@@ -11,6 +11,8 @@
 #'   height is computed with HTML/CSS.
 #' @param inline use an inline (`span()`) or block container 
 #' (`div()`) for the output
+#' @param reportTheme whether or not to report CSS styles (if a sufficient
+#' version of shiny and htmlwidgets is available).
 #' @param expr An expression that generates a plotly
 #' @param env The environment in which to evaluate `expr`.
 #' @param quoted Is `expr` a quoted expression (with `quote()`)? This 
@@ -22,8 +24,8 @@
 #'
 #' @export
 plotlyOutput <- function(outputId, width = "100%", height = "400px", 
-                         inline = FALSE) {
-  htmlwidgets::shinyWidgetOutput(
+                         inline = FALSE, reportTheme = TRUE) {
+  args <- list(
     outputId = outputId, 
     name = "plotly", 
     width = width, 
@@ -32,6 +34,10 @@ plotlyOutput <- function(outputId, width = "100%", height = "400px",
     package = "plotly",
     reportSize = TRUE
   )
+  if (is_available("shiny", "1.4.0.9003") && is_available("htmlwidgets", "1.5.1.9001")) {
+    args$reportTheme <- reportTheme
+  }
+  do.call(htmlwidgets::shinyWidgetOutput, args)
 }
 
 #' @rdname plotly-shiny
diff --git a/R/utils.R b/R/utils.R
@@ -1137,6 +1137,15 @@ try_library <- function(pkg, fun = NULL) {
        "Please install and try again.", call. = FALSE)
 }
 
+# a la shiny:::is_available
+is_available <- function(package, version = NULL) {
+  installed <- nzchar(system.file(package = package))
+  if (is.null(version)) {
+    return(installed)
+  }
+  installed && isTRUE(utils::packageVersion(package) >= version)
+}
+
 # similar logic to rstudioapi::isAvailable()
 is_rstudio <- function() {
   identical(.Platform$GUI, "RStudio")
diff --git a/man/plotly-shiny.Rd b/man/plotly-shiny.Rd
diff --git a/man/plotly_IMAGE.Rd b/man/plotly_IMAGE.Rd
