add a refresh function; fixes #205

daattali · Apr 5, 2020 · cfc5aaf · cfc5aaf
1 parent 5254259
commit cfc5aaf
Show file tree

Hide file tree

Showing 16 changed files with 121 additions and 33 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: shinyjs
 Title: Easily Improve the User Experience of Your Shiny Apps in Seconds
-Version: 1.1.0.9000
+Version: 1.1.0.9001
 Authors@R: person("Dean", "Attali", email = "[email protected]",
     role = c("aut", "cre"))
 Description: Perform common useful JavaScript operations in Shiny apps that will
@@ -28,4 +28,4 @@ License: AGPL-3
 SystemRequirements: pandoc with https support
 LazyData: true
 VignetteBuilder: knitr
-RoxygenNote: 6.1.1
+RoxygenNote: 7.1.0
diff --git a/NAMESPACE b/NAMESPACE
@@ -21,6 +21,7 @@ export(js)
 export(logjs)
 export(onclick)
 export(onevent)
+export(refresh)
 export(removeClass)
 export(removeCssClass)
 export(reset)

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,9 @@
+# shinyjs 1.1.0.*
+
+TODO date
+
+- New feature: add a `refresh()` function (#205)
+
 # shinyjs 1.1
 
 2020-01-12

diff --git a/R/refresh.R b/R/refresh.R
@@ -0,0 +1,10 @@
+#' Refresh the page
+#' 
+#' @export
+refresh <- function() {
+  fxn <- "refresh"
+  params <- list()
+  jsFuncHelper(fxn, params)
+}
+
+
diff --git a/R/useShinyjs.R b/R/useShinyjs.R
@@ -73,7 +73,7 @@ useShinyjs <- function(rmd = FALSE, debug = FALSE, html = FALSE,
   # all the default shinyjs methods that should be forwarded to javascript
   jsFuncs <- c("show", "hide", "toggle", "enable", "disable", "toggleState",
                "addClass", "removeClass", "toggleClass", "html", "onevent",
-               "alert", "logjs", "runjs", "reset", "delay", "click")
+               "alert", "logjs", "runjs", "reset", "delay", "click", "refresh")
 
   # grab the file with all the default shinyjs javascript functions
   shiny::addResourcePath("shinyjs", system.file("srcjs", package = "shinyjs"))

diff --git a/inst/srcjs/shinyjs-default-funcs.js b/inst/srcjs/shinyjs-default-funcs.js
@@ -805,6 +805,16 @@ shinyjs = function() {
       var $el = _getElements(params);
       if ($el === null) return;
       $el[0].click();
+    },
+
+    // refresh the page
+    refresh : function(params) {
+      var defaultParams = {
+        id : null
+      };
+      params = shinyjs.getParams(params, defaultParams);
+
+      window.location.reload(false);
     }
   };
 }();

diff --git a/man/classFuncs.Rd b/man/classFuncs.Rd
diff --git a/man/html.Rd b/man/html.Rd
diff --git a/man/js.Rd b/man/js.Rd
diff --git a/man/onevent.Rd b/man/onevent.Rd
diff --git a/man/refresh.Rd b/man/refresh.Rd
diff --git a/man/runcode.Rd b/man/runcode.Rd
diff --git a/man/shinyjs.Rd b/man/shinyjs.Rd
diff --git a/man/stateFuncs.Rd b/man/stateFuncs.Rd
diff --git a/man/useShinyjs.Rd b/man/useShinyjs.Rd
diff --git a/man/visibilityFuncs.Rd b/man/visibilityFuncs.Rd