R/notifications.R

In ymd526442121/Rproject_shiny: Web Application Framework for R

#' Show or remove a notification
#'
#' These functions show and remove notifications in a Shiny application.
#'
#' @param ui Content of message.
#' @param action Message content that represents an action. For example, this
#'   could be a link that the user can click on. This is separate from \code{ui}
#'   so customized layouts can handle the main notification content separately
#'   from action content.
#' @param duration Number of seconds to display the message before it
#'   disappears. Use \code{NULL} to make the message not automatically
#'   disappear.
#' @param closeButton If \code{TRUE}, display a button which will make the
#'   notification disappear when clicked. If \code{FALSE} do not display.
#' @param id An ID string. This can be used to change the contents of an
#'   existing message with \code{showNotification}, or to remove it with
#'   \code{removeNotification}. If not provided, one will be generated
#'   automatically. If an ID is provided and there does not currently exist a
#'   notification with that ID, a new notification will be created with that ID.
#' @param type A string which controls the color of the notification. One of
#'   "default" (gray), "message" (blue), "warning" (yellow), or "error" (red).
#' @param session Session object to send notification to.
#'
#' @return An ID for the notification.
#'
#' @examples
#' ## Only run examples in interactive R sessions
#' if (interactive()) {
#' # Show a message when button is clicked
#' shinyApp(
#'   ui = fluidPage(
#'     actionButton("show", "Show")
#'   ),
#'   server = function(input, output) {
#'     observeEvent(input$show, {
#'       showNotification("Message text",
#'         action = a(href = "javascript:location.reload();", "Reload page")
#'       )
#'     })
#'   }
#' )
#'
#' # App with show and remove buttons
#' shinyApp(
#'   ui = fluidPage(
#'     actionButton("show", "Show"),
#'     actionButton("remove", "Remove")
#'   ),
#'   server = function(input, output) {
#'     # A queue of notification IDs
#'     ids <- character(0)
#'     # A counter
#'     n <- 0
#'
#'     observeEvent(input$show, {
#'       # Save the ID for removal later
#'       id <- showNotification(paste("Message", n), duration = NULL)
#'       ids <<- c(ids, id)
#'       n <<- n + 1
#'     })
#'
#'     observeEvent(input$remove, {
#'       if (length(ids) > 0)
#'         removeNotification(ids[1])
#'       ids <<- ids[-1]
#'     })
#'   }
#' )
#' }
#' @export
showNotification <- function(ui, action = NULL, duration = 5,
  closeButton = TRUE, id = NULL,
  type = c("default", "message", "warning", "error"),
  session = getDefaultReactiveDomain())
{

  if (is.null(id))
    id <- randomID()

  res <- processDeps(ui, session)
  actionRes <- processDeps(action, session)

  session$sendNotification("show",
    list(
      html = res$html,
      action = actionRes$html,
      deps = c(res$deps, actionRes$deps),
      duration = if (!is.null(duration)) duration * 1000,
      closeButton = closeButton,
      id = id,
      type = match.arg(type)
    )
  )

  id
}

#' @rdname showNotification
#' @export
removeNotification <- function(id = NULL, session = getDefaultReactiveDomain()) {
  if (is.null(id)) {
    stop("id is required.")
  }
  session$sendNotification("remove", id)
  id
}