R/dashboardPage.R

In shinydashboard: Create Dashboards with 'Shiny'

#' Dashboard page
#'
#' This creates a dashboard page for use in a Shiny app.
#'
#' @param header A header created by [dashboardHeader()].
#' @param sidebar A sidebar created by [dashboardSidebar()].
#' @param body A body created by [dashboardBody()].
#' @param title A title to display in the browser's title bar. If no value is
#'   provided, it will try to extract the title from the [dashboardHeader()].
#' @param skin A color theme. One of `"blue"`, `"black"`,
#'   `"purple"`, `"green"`, `"red"`, or `"yellow"`.
#'
#' @seealso [dashboardHeader()], [dashboardSidebar()],
#'   [dashboardBody()].
#' @examples
#' ## Only run this example in interactive R sessions
#' if (interactive()) {
#' # Basic dashboard page template
#' library(shiny)
#' shinyApp(
#'   ui = dashboardPage(
#'     dashboardHeader(),
#'     dashboardSidebar(),
#'     dashboardBody(),
#'     title = "Dashboard example"
#'   ),
#'   server = function(input, output) { }
#' )
#' }
#' @export
dashboardPage <- function(
  header,
  sidebar,
  body,
  title = NULL,
  skin = c("blue", "black", "purple", "green", "red", "yellow")
) {
  tagAssert(header, type = "header", class = "main-header")
  tagAssert(sidebar, type = "aside", class = "main-sidebar")
  tagAssert(body, type = "div", class = "content-wrapper")
  skin <- match.arg(skin)

  extractTitle <- function(header) {
    x <- header$children[[2]]
    if (
      x$name == "span" &&
        !is.null(x$attribs$class) &&
        x$attribs$class == "logo" &&
        length(x$children) != 0
    ) {
      x$children[[1]]
    } else {
      ""
    }
  }

  title <- title %OR% extractTitle(header)

  content <- div(class = "wrapper", header, sidebar, body)

  # if the sidebar has the attribute `data-collapsed = "true"`, it means that
  # the user set the `collapsed` argument of `dashboardSidebar` to TRUE
  collapsed <- findAttribute(sidebar, "data-collapsed", "true")

  addDeps(
    tags$body(
      # the "sidebar-collapse" class on the body means that the sidebar should
      # the collapsed (AdminLTE code)
      class = paste0("skin-", skin, if (collapsed) " sidebar-collapse"),
      style = "min-height: 611px;",
      shiny::bootstrapPage(content, title = title)
    )
  )
}