showLog() no longer needs to be specified in useShinyjs(), and it…

… can be used by just calling it in the server code once (fixes #105)
daattali · Dec 11, 2016 · 2969dc7 · 2969dc7
1 parent e91a1fb
commit 2969dc7
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 29 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,7 @@
 # shinyjs 0.8.xxxx
 
 - added support for shinyAce editor as the input for `runcodeUI()` (#93)
+- `showLog()` no longer needs to be specified in `useShinyjs()`, and it can be used by just calling it in the server code once (#105)
 - fixed bug where `showLog()` would only show the last message if multiple messages were printed in succession (#99)
 - fixed bug where date inputs could not be reset to empty (#100)
 - fixed textArea inputs not getting disabled when disabling a parent element

diff --git a/R/showLog.R b/R/showLog.R
@@ -18,7 +18,7 @@
 #'
 #'   shinyApp(
 #'     ui = fluidPage(
-#'       useShinyjs(showLog = TRUE),  # Set up shinyjs with showLog
+#'       useShinyjs(),
 #'       textInput("text", "Type something")
 #'     ),
 #'     server = function(input, output) {
@@ -33,6 +33,23 @@
 #' @export
 showLog <- function() {
   session <- getSession()
+
+  # Capture the console.log function and overwrite it to send the message to R
+  shiny::insertUI("head", "beforeEnd", {
+    shiny::singleton(shiny::tags$head(shiny::tags$script(
+      '(function(){
+        var oldLog = console.log;
+        var queue = new ShinySenderQueue();
+        console.log = function (message) {
+          try {
+            queue.send("shinyjs-showLog", message);
+          } catch(err) {}
+          oldLog.apply(console, arguments);
+        };
+      })();'
+    )))
+  })
+
   shiny::observeEvent(session$input[['shinyjs-showLog']], {
     message("JAVASCRIPT LOG: ",
             jsonlite::toJSON(session$input[['shinyjs-showLog']],

diff --git a/R/useShinyjs.R b/R/useShinyjs.R
@@ -16,10 +16,7 @@
 #' using this option, view the
 #' \href{https://github.com/daattali/shinyjs}{README} online to learn
 #' how to use shinyjs in these apps.
-#' @param showLog Set this to \code{TRUE} if you want to print all JavaScript
-#' log messages in the R console. This is useful for debugging. If using this
-#' option, you must also call the \code{\link[shinyjs]{showLog}} function in
-#' the server.
+#' @param showLog Deprecated.
 #' @return Scripts that \code{shinyjs} requires that are automatically inserted
 #' to the app's \code{<head>} tag.
 #' @examples
@@ -44,11 +41,15 @@
 #' \code{\link[shinyjs]{extendShinyjs}}
 #' @export
 useShinyjs <- function(rmd = FALSE, debug = FALSE, html = FALSE,
-                       showLog = FALSE) {
+                       showLog = NULL) {
   stopifnot(rmd == TRUE || rmd == FALSE)
   stopifnot(debug == TRUE || debug == FALSE)
   stopifnot(html == TRUE || html == FALSE)
-  stopifnot(showLog == TRUE || showLog == FALSE)
+
+  if (!missing(showLog)) {
+    warning("'showLog' has been deprecated. You do not need to call it anymore.",
+            call. = FALSE)
+  }
 
   # `astext` is FALSE in normal shiny apps where the shinyjs content is returned
   # as a shiny tag that gets rendered by the Shiny UI, and TRUE in interactive
@@ -78,22 +79,6 @@ useShinyjs <- function(rmd = FALSE, debug = FALSE, html = FALSE,
     initJS <- "shinyjs.debug = false;"
   }
 
-  # Capture the console.log function and overwrite it to send the message to R
-  if (showLog) {
-    initJS <- paste0(
-      initJS,
-      '(function(){
-         var oldLog = console.log;
-         var queue = new ShinySenderQueue();
-         console.log = function (message) {
-           try {
-             queue.send("shinyjs-showLog", message);
-           } catch(err) {}
-           oldLog.apply(console, arguments);
-        };
-      })();')
-  }
-
   # include CSS for hiding elements
   initCSS <- inlineCSS(".shinyjs-hide { display: none !important; }")
 

diff --git a/man/showLog.Rd b/man/showLog.Rd
diff --git a/man/useShinyjs.Rd b/man/useShinyjs.Rd