Create toastr notifications

Description

There are four functions to create notifications: toastr_success, toastr_info, toastr_warning and toastr_error. They have exactly the same arguments and API in general, but they create different kinds of notifications, styled appropriately.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
toastr_success(message, title = "", closeButton = FALSE,
  newestOnTop = FALSE, progressBar = FALSE, position = c("top-right",
  "top-center", "top-left", "top-full-width", "bottom-right", "bottom-center",
  "bottom-left", "bottom-full-width"), preventDuplicates = FALSE,
  showDuration = 300, hideDuration = 1000, timeOut = 5000,
  extendedTimeOut = 1000, showEasing = c("swing", "linear"),
  hideEasing = c("swing", "linear"), showMethod = c("fadeIn", "slideDown",
  "show"), hideMethod = c("fadeOut", "hide"))

toastr_info(message, title = "", closeButton = FALSE, newestOnTop = FALSE,
  progressBar = FALSE, position = c("top-right", "top-center", "top-left",
  "top-full-width", "bottom-right", "bottom-center", "bottom-left",
  "bottom-full-width"), preventDuplicates = FALSE, showDuration = 300,
  hideDuration = 1000, timeOut = 5000, extendedTimeOut = 1000,
  showEasing = c("swing", "linear"), hideEasing = c("swing", "linear"),
  showMethod = c("fadeIn", "slideDown", "show"), hideMethod = c("fadeOut",
  "hide"))

toastr_warning(message, title = "", closeButton = FALSE,
  newestOnTop = FALSE, progressBar = FALSE, position = c("top-right",
  "top-center", "top-left", "top-full-width", "bottom-right", "bottom-center",
  "bottom-left", "bottom-full-width"), preventDuplicates = FALSE,
  showDuration = 300, hideDuration = 1000, timeOut = 5000,
  extendedTimeOut = 1000, showEasing = c("swing", "linear"),
  hideEasing = c("swing", "linear"), showMethod = c("fadeIn", "slideDown",
  "show"), hideMethod = c("fadeOut", "hide"))

toastr_error(message, title = "", closeButton = FALSE,
  newestOnTop = FALSE, progressBar = FALSE, position = c("top-right",
  "top-center", "top-left", "top-full-width", "bottom-right", "bottom-center",
  "bottom-left", "bottom-full-width"), preventDuplicates = FALSE,
  showDuration = 300, hideDuration = 1000, timeOut = 5000,
  extendedTimeOut = 1000, showEasing = c("swing", "linear"),
  hideEasing = c("swing", "linear"), showMethod = c("fadeIn", "slideDown",
  "show"), hideMethod = c("fadeOut", "hide"))

Arguments

message

Message to show.

title

Optional title, shown on the top.

closeButton

Whether to show a close button. Even if there is a close button, the notification can still be closed by clicking on it. For sticky notifications, it is good practice to show the close button, to tell the user that the notification can be closed.

newestOnTop

Whether to have the newest notification on the top.

progressBar

Whether to show a progress bar.

position

Where to put the notification. Possible values: top-right, top-center, top-left, top-full-width, and the corresponding bottom-right, etc.

preventDuplicates

Whether to prevent showing exactly the same message as the previous one. Note that only the message matters here, the title is ignored.

showDuration

How long the initial show transition should take, in milliseconds.

hideDuration

How long the final hide transition should take, in milliseconds.

timeOut

How long the notification should be kept on the screen, in milliseconds. Set it to zero to keep it on the screen until it is clicked. Note that if the mouse cursor is over the notification, then it is kept on the screen for extendedTimeOut milliseconds, after the cursor has left.

extendedTimeOut

How long to keep the notification on the screen after the mouse cursor leaves it, in milliseconds.

showEasing

Animation easing to show the notification. Possible values: swing, linear.

hideEasing

Animation easing to hide the notification. Possible values: swing, linear.

showMethod

Animation to show the notification. Possible values: fadeIn, slideDown, show.

hideMethod

Animation to hide the notification. Possible values: fadeOut, hide.

Details

By default, the notifications disappear automatically after a timeout, unless the mouse cursor is over them.

Example

You typically use these functions in the definition of the Shiny server program, as a response to an event, i.e. in the output functions, reactives, or in observe or observeEvent. Here is an example that shows a note when the data was successfully written to a database, and an error otherwise.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
  observeEvent(
    input$save_button,
    {
      tryCatch(
        {
          writeToDB(data)
          toastr_success("Saved to database")
        },
        error = function(e) {
          toastr_error(title = "Database error", conditionMessage(e))
        }
      }
    

)

See Also

useToastr

Examples

1
## See above

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.