R/argonFooter.R

In RinteRface/argonR: R Interface to Argon HTML Design

#' Create a Boostrap 4 argon footer
#'
#' Build an argon footer
#'
#' @param ... Footer content.
#' @param has_card Enable card rendering in the footer. FALSE by default.
#' @param status  Footer status color. See \url{https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html}.
#' @param gradient Whether to apply a gradient. FALSE by default.
#'
#' @examples
#' if(interactive()){
#'  library(argonR)
#'  argonFooter(
#'   has_card = FALSE,
#'   argonContainer(
#'     size = "lg",
#'     argonRow(
#'       argonColumn(
#'         width = 6,
#'         argonIconWrapper(
#'           iconTag = argonIcon("atom"),
#'           size = "lg",
#'           status = "success",
#'           shadow = TRUE,
#'           hover_shadow = TRUE
#'         ),
#'         argonH1(
#'           display = 3,
#'           "Insert anything in the footer"
#'         ),
#'         argonLead(
#'           "The Arctic Ocean freezes every winter and much of 
#'           the sea-ice then thaws every summer, and that process 
#'           will continue whatever"
#'         )
#'         ),
#'       argonColumn(
#'         width = 6,
#'         argonCarousel(
#'           width = 12,
#'           id = "carousel2",
#'           argonCarouselItem(
#'             src = "http://www.72pxdesigns.com/wp-content/uploads/2017/06/preview-814162.png",
#'             active = TRUE
#'           ),
#'           argonCarouselItem(
#'             src = "http://www.72pxdesigns.com/wp-content/uploads/2017/06/preview-814162.png",
#'             active = FALSE
#'           )
#'         )
#'       )
#'     )
#'    )
#'  )
#' }
#'
#' @author David Granjon, \email{dgranjon@@ymail.com}
#'
#' @export
argonFooter <- function(..., has_card = FALSE, status = NULL, gradient = FALSE) {
  
  footerCl <- "footer"
  if (!is.null(status)) {
    if (gradient) {
      footerCl <- paste0(footerCl, " bg-gradient-", status)
    } else {
      footerCl <- paste0(footerCl, " bg-", status)
    }
  }
  if (has_card) footerCl <- paste0(footerCl, " has-cards")
  
  htmltools::tags$footer(class = footerCl, ...)
  
}