R/dashboardFooter.R

In gyang274/ygdashboard: Create Dashboards with 'Shiny' and 'adminLTE'.

#' The footer of a dashboard page.
#'
#' The footer typically contains copyright info. Another common use pattern
#' is for the footer to contain dynamic message commnuncation.
#'
#' @param ... Items to put in the dashboard body.
#'
#' @seealso \code{\link{tabItems}}, \code{\link{box}}, \code{\link{valueBox}}.
#'
#' @export
dashboardFooter <- function(
  mainText = HTML('<strong>Copyright &copy; 2016 <a href="https://github.com/gyang274/ygdashboard">Guang Yang</a>.</strong> All rights reserved.'),
  subText  = HTML("<b>Version</b> 2.3.3")) {

  tags$footer(
    class="main-footer",
    tags$div(
      class="pull-right hidden-xs",
      subText
    ),
    mainText
  )

}


#' Create a dynamic footer output for ygdashboard (client side)
#'
#' This can be used as a placeholder for dynamically-generated \code{\link{dashboardFooter}}.
#'
#' @param outputId Output variable name.
#' @param tag A tag function, like \code{tags$li} or \code{tags$ul}.
#'
#' @seealso \code{\link{renderFooter}} for the corresponding server side function
#'   and examples.
#' @family footer outputs
#' @export
footerOutput <- function(outputId) {
  moduleOutput(outputId = outputId, tag = tags$footer)
}


#' Create dynamic footer (server side)
#'
#' @inheritParams shiny::renderUI
#'
#' @seealso \code{\link{footerOutput}} for the corresponding client side function
#'   and examples.
#' @family footer outputs
#' @export
renderFooter <- shiny::renderUI