Handle search/hash URL components and custom app locations

DESCRIPTION

@@ -13,7 +13,7 @@ Description: Simulate routing within a 'shiny' application by observering
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.1.0
+RoxygenNote: 7.1.1
 Imports: 
     fs,
     htmltools,

R/url.R

@@ -109,18 +109,25 @@ peek_params <- function() {
 #' Push a new URL path or get the current path.
 #'
 #' @param path A character string specifying a new URL path
+#' @param mode Either `"push"` or `"replace"`. If `"push"`, the default, the
+#'   path is pushed onto the history stack and pressing the back button in the
+#'   browser will redirect to the current path (before pushing the path). If
+#'   `"replace"`, then the pushed path will replace the current path without
+#'   changing the next page in the browser's back button stack.
 #'
 #' @param session A reactive context, defaults to
 #'   `shiny::getDefaultReactiveDomain()`.
 #'
 #' @export
-pushPath <- function(path, session = getDefaultReactiveDomain()) {
+pushPath <- function(path, mode = c("push", "replace"), session = getDefaultReactiveDomain()) {
   path <- path_app(path)
+  mode <- match.arg(mode)
 
   path <- utils::URLencode(path)
 
   session$sendCustomMessage("blaze:pushstate", list(
-    path = path
+    path = path,
+    mode = mode
   ))
 }
 

inst/www/js/blaze.js

@@ -38,10 +38,16 @@
   })();
 
   window.addEventListener("DOMContentLoaded", function() {
-    var _path = function(path) {
+    var _path = function(path, mode) {
       const uri = pathURI(path);
       if (uri) {
-        history.pushState(uri, null, uri);
+        if ((mode || "push") === "push") {
+          history.pushState({uri, pathname: path}, null, uri);
+        } else if (mode === "replace") {
+          history.replaceState({uri, pathname: path}, null, uri);
+        } else {
+          throw `Unknown blaze::pushPath() mode: ${mode}`;
+        }
         sendState(path);
       }
     };
@@ -68,12 +74,13 @@
 
     Shiny.addCustomMessageHandler("blaze:pushstate", function(msg) {
       if (msg.path) {
-        _path(msg.path);
+        _path(msg.path, msg.mode || "push");
       }
     });
   });
 
   window.addEventListener("popstate", function(event) {
-    sendState(event.state.replace(/[?#].+$/, '') || "/");
+    let {pathname} = event.state || window.location;
+    sendState(pathname || "/");
   });
 })(window.jQuery, window.Shiny);