R/showToast.R

In shinyFeedback: Display User Feedback in Shiny Apps

#' @noRd showToast_default_options
showToast_default_options <- list(
  positionClass = "toast-bottom-center",
  progressBar = TRUE,
  timeOut = 4000,
  closeButton = TRUE,
  # same as defaults
  newestOnTop = FALSE,
  preventDuplicates = FALSE,
  showDuration = 300,
  hideDuration = 1000,
  extendedTimeOut = 1000,
  showEasing = "swing",
  hideEasing = "swing",
  showMethod = "fadeIn",
  hideMethod = "fadeOut"
)

#' show toast message
#'
#' A wrapper around the `toastr` JavaScript library that uses our preferred default argument
#' values.
#'
#' @param type length 1 character vector.  Valid values are "success", "error", "warning", and "info"
#' @param message the toast message
#' @param title the toast title.  Defaults to \code{NULL}
#' @param keepVisible a logical. If \code{TRUE}, the toast notification will remain visible until removed with \code{\link{hideToast}}. If \code{FALSE}, the default, the toast will automatically hide once the "showDuration" option has elapsed.
#' @param .options other options to pass to the \code{toastr} JavaScript library.  See 
#' \url{https://codeseven.github.io/toastr/demo.html} for a full demo of options. Valid options are "positionClass",
#' "progressBar", "timeOut", "closeButton", "newestOnTop", "preventDuplicates", "showDuration", "hideDuration", 
#' "extendedTimeOut", "showEasing", "hideEasing", "showMethod", & "hideMethod"
#' @param session the Shiny session.  Defaults to \code{shiny::getDefaultReactiveDomain()}.
#'
#' @export
#'
#' @importFrom shiny getDefaultReactiveDomain
#' @importFrom utils modifyList
#'
#' @return `invisible()`
#'
showToast <- function(
  type, 
  message,
  title = NULL,
  keepVisible = FALSE,
  .options = list(),
  session = shiny::getDefaultReactiveDomain()
) {
  
  if (!is.list(.options)) {
    stop("`.options` must be a list", call. = FALSE)
  }
  
  # Incorrect option
  if (!all(names(.options) %in% names(showToast_default_options))) {
    stop('Incorrect `.options` supplied', call. = FALSE)
  }
  
  # Update default options
  .options <- modifyList(showToast_default_options, .options)
  
  # Argument `keepVisible = TRUE`
  if (isTRUE(keepVisible)) {
    .options$timeOut <- 0
    .options$extendedTimeOut <- 0
  }
  
  session$sendCustomMessage(
    type = "toastr",
    message = list(
      'type' = type,
      'message' = message,
      'title' = title,
      'options' = .options
    )
  )
  
  invisible()
}