soft-deprecate bootstrapPage() and basicPage(). Fixes #2594

NEWS.md

@@ -52,8 +52,6 @@ shiny 1.3.2.9001
 
 * Fixed [rstudio/reactlog#36](https://github.com/rstudio/reactlog/issues/36): Changes to reactive values not displaying accurately in reactlog. ([#2424](https://github.com/rstudio/shiny/pull/2424))
 
-* Fixed [#2598](https://github.com/rstudio/shiny/issues/2598): Showcase files don't appear with a wide window. ([#2582](https://github.com/rstudio/shiny/pull/2582))
-
 * Fixed [#2329](https://github.com/rstudio/shiny/issues/2329), [#1817](https://github.com/rstudio/shiny/issues/1817): These bugs were reported as fixed in Shiny 1.3.0 but were not actually fixed because some JavaScript changes were accidentally not included in the release. The fix resolves issues that occur when `withProgressBar()` or bookmarking are combined with the [networkD3](https://christophergandrud.github.io/networkD3/) package's Sankey plot.
 
 ### Library updates

R/app.R

@@ -121,10 +121,8 @@ shinyAppDir <- function(appDir, options=list()) {
   appDir <- normalizePath(appDir, mustWork = TRUE)
 
   if (file.exists.ci(appDir, "server.R")) {
-    shinyOptions(appFile = "server.R")
     shinyAppDir_serverR(appDir, options = options)
   } else if (file.exists.ci(appDir, "app.R")) {
-    shinyOptions(appFile = "app.R")
     shinyAppDir_appR("app.R", appDir, options = options)
   } else {
     stop("App dir must contain either app.R or server.R.")
@@ -138,7 +136,6 @@ shinyAppFile <- function(appFile, options=list()) {
   appFile <- normalizePath(appFile, mustWork = TRUE)
   appDir <- dirname(appFile)
 
-  shinyOptions(appFile = basename(appFile))
   shinyAppDir_appR(basename(appFile), appDir, options = options)
 }
 

R/bootstrap-deprecated.R

@@ -45,3 +45,47 @@ headerPanel <- function(title, windowTitle=title) {
     )
   )
 }
+
+
+#' Create a Bootstrap page
+#'
+#' **DEPRECATED**: use [fluidPage()] instead.
+#'
+#' @param ... The contents of the document body.
+#' @param title The browser window title (defaults to the host URL of the page)
+#' @param responsive This option is deprecated; it is no longer optional with
+#'   Bootstrap 3.
+#' @param theme Alternative Bootstrap stylesheet (normally a css file within the
+#'   www directory, e.g. `www/bootstrap.css`)
+#'
+#' @return A UI defintion that can be passed to the [shinyUI] function.
+#'
+#' @keywords internal
+#' @seealso [fluidPage()], [fixedPage()]
+#' @export
+bootstrapPage <- function(..., title = NULL, responsive = NULL, theme = NULL) {
+
+  if (!is.null(responsive)) {
+    shinyDeprecated("The 'responsive' argument is no longer used with Bootstrap 3.")
+  }
+
+  attachDependencies(
+    tagList(
+      if (!is.null(title)) tags$head(tags$title(title)),
+      if (!is.null(theme)) {
+        tags$head(tags$link(rel="stylesheet", type="text/css", href = theme))
+      },
+
+      # remainder of tags passed to the function
+      list(...)
+    ),
+    bootstrapLib()
+  )
+}
+
+
+#' @rdname bootstrapPage
+#' @export
+basicPage <- function(...) {
+  bootstrapPage(div(class="container-fluid", list(...)))
+}

R/bootstrap.R

@@ -1,51 +1,6 @@
 #' @include utils.R
 NULL
 
-#' Create a Bootstrap page
-#'
-#' Create a Shiny UI page that loads the CSS and JavaScript for
-#' [Bootstrap](http://getbootstrap.com/), and has no content in the page
-#' body (other than what you provide).
-#'
-#' This function is primarily intended for users who are proficient in HTML/CSS,
-#' and know how to lay out pages in Bootstrap. Most applications should use
-#' [fluidPage()] along with layout functions like
-#' [fluidRow()] and [sidebarLayout()].
-#'
-#' @param ... The contents of the document body.
-#' @param title The browser window title (defaults to the host URL of the page)
-#' @param responsive This option is deprecated; it is no longer optional with
-#'   Bootstrap 3.
-#' @param theme Alternative Bootstrap stylesheet (normally a css file within the
-#'   www directory, e.g. `www/bootstrap.css`)
-#'
-#' @return A UI defintion that can be passed to the [shinyUI] function.
-#'
-#' @note The `basicPage` function is deprecated, you should use the
-#'   [fluidPage()] function instead.
-#'
-#' @seealso [fluidPage()], [fixedPage()]
-#' @export
-bootstrapPage <- function(..., title = NULL, responsive = NULL, theme = NULL) {
-
-  if (!is.null(responsive)) {
-    shinyDeprecated("The 'responsive' argument is no longer used with Bootstrap 3.")
-  }
-
-  attachDependencies(
-    tagList(
-      if (!is.null(title)) tags$head(tags$title(title)),
-      if (!is.null(theme)) {
-        tags$head(tags$link(rel="stylesheet", type="text/css", href = theme))
-      },
-
-      # remainder of tags passed to the function
-      list(...)
-    ),
-    bootstrapLib()
-  )
-}
-
 #' Bootstrap libraries
 #'
 #' This function returns a set of web dependencies necessary for using Bootstrap
@@ -76,12 +31,6 @@ bootstrapLib <- function(theme = NULL) {
   )
 }
 
-#' @rdname bootstrapPage
-#' @export
-basicPage <- function(...) {
-  bootstrapPage(div(class="container-fluid", list(...)))
-}
-
 
 #' Create a page that fills the window
 #'

R/showcase.R

@@ -81,8 +81,8 @@ appMetadata <- function(desc) {
 navTabsHelper <- function(files, prefix = "") {
   lapply(files, function(file) {
     with(tags,
-      li(class=if (identical(file, getShinyOption("appFile"))) "active" else "",
-         a(href=paste0("#", gsub("\\.|\\s+", "_", file), "_code"),
+      li(class=if (tolower(file) %in% c("app.r", "server.r")) "active" else "",
+         a(href=paste("#", gsub(".", "_", file, fixed=TRUE), "_code", sep=""),
            "data-toggle"="tab", paste0(prefix, file)))
     )
   })
@@ -105,10 +105,12 @@ navTabsDropdown <- function(files) {
 tabContentHelper <- function(files, path, language) {
   lapply(files, function(file) {
     with(tags,
-      div(class=paste0("tab-pane",
-                      if (identical(file, getShinyOption("appFile"))) " active"
-                      else ""),
-          id=paste0(gsub("\\.|\\s+", "_", file), "_code"),
+      div(class=paste("tab-pane",
+                      if (tolower(file) %in% c("app.r", "server.r")) " active"
+                      else "",
+                      sep=""),
+          id=paste(gsub(".", "_", file, fixed=TRUE),
+                   "_code", sep=""),
           pre(class="shiny-code",
               # we need to prevent the indentation of <code> ... </code>
               HTML(format(tags$code(

inst/www/shared/shiny-showcase.js

@@ -82,9 +82,7 @@
       el = document.createElement("span");
       el.id = "srcref_" + srcref;
       var ref = srcref;
-      var code = document.getElementById(srcfile.replace(/\.|\s+/g, "_") + "_code");
-      // if there is no code file (might be a shiny file), quit early
-      if (!code) return;
+      var code = document.getElementById(srcfile.replace(/\./g, "_") + "_code");
       var start = findTextPoint(code, ref[0], ref[4]);
       var end = findTextPoint(code, ref[2], ref[5]);
 
@@ -150,8 +148,6 @@
       }
     }
 
-    // hide the new element before doing anything to it
-    $(newHostElement).hide();
     $(currentHostElement).fadeOut(animateCodeMs, function() {
       var tabs = document.getElementById("showcase-code-tabs");
       currentHostElement.removeChild(tabs);
@@ -164,7 +160,7 @@
         document.getElementById("showcase-code-content").removeAttribute("style");
       }
 
-      $(newHostElement).fadeIn(animateCodeMs);
+      $(newHostElement).fadeIn();
       if (!above) {
         // remove the applied width and zoom on the app container, and
         // scroll smoothly down to the code's new home
@@ -193,6 +189,7 @@
     if (above) {
       $(document.body).animate({ scrollTop: 0 }, animateCodeMs);
     }
+    $(newHostElement).hide();
     isCodeAbove = above;
     setAppCodeSxsWidths(above && animate);
     $(window).trigger("resize");

man/bootstrapPage.Rd

@@ -1,5 +1,5 @@
 % Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/bootstrap.R
+% Please edit documentation in R/bootstrap-deprecated.R
 \name{bootstrapPage}
 \alias{bootstrapPage}
 \alias{basicPage}
@@ -24,20 +24,9 @@ www directory, e.g. \code{www/bootstrap.css})}
 A UI defintion that can be passed to the \link{shinyUI} function.
 }
 \description{
-Create a Shiny UI page that loads the CSS and JavaScript for
-\href{http://getbootstrap.com/}{Bootstrap}, and has no content in the page
-body (other than what you provide).
-}
-\details{
-This function is primarily intended for users who are proficient in HTML/CSS,
-and know how to lay out pages in Bootstrap. Most applications should use
-\code{\link[=fluidPage]{fluidPage()}} along with layout functions like
-\code{\link[=fluidRow]{fluidRow()}} and \code{\link[=sidebarLayout]{sidebarLayout()}}.
-}
-\note{
-The \code{basicPage} function is deprecated, you should use the
-\code{\link[=fluidPage]{fluidPage()}} function instead.
+\strong{DEPRECATED}: use \code{\link[=fluidPage]{fluidPage()}} instead.
 }
 \seealso{
 \code{\link[=fluidPage]{fluidPage()}}, \code{\link[=fixedPage]{fixedPage()}}
 }
+\keyword{internal}