Element Plus Message Box — el_message

A modal that asks something and waits for an answer: a confirmation, an acknowledgement, or a line of text.

Usage

el_message_box(
  session = shiny::getDefaultReactiveDomain(),
  id,
  message,
  title = NULL,
  type = NULL,
  box_type = c("confirm", "alert", "prompt"),
  confirm_button_text = NULL,
  cancel_button_text = NULL,
  show_cancel_button = NULL,
  show_close = NULL,
  center = FALSE,
  round_button = FALSE,
  dangerously_use_html_string = FALSE,
  custom_class = NULL,
  close_on_click_modal = NULL,
  close_on_press_escape = NULL,
  input_placeholder = NULL,
  input_value = NULL,
  input_pattern = NULL,
  input_error_message = NULL,
  input_type = NULL,
  input_validator = NULL,
  show_input = NULL,
  show_confirm_button = NULL,
  confirm_button_class = NULL,
  cancel_button_class = NULL,
  distinguish_cancel_and_close = NULL,
  lock_scroll = NULL,
  close_on_hash_change = NULL,
  before_close = NULL,
  custom_style = NULL,
  icon = NULL,
  close_icon = NULL,
  confirm_button_type = NULL,
  cancel_button_type = NULL,
  confirm_button_loading_icon = NULL,
  cancel_button_loading_icon = NULL,
  autofocus = NULL,
  modal = NULL,
  modal_class = NULL,
  draggable = NULL,
  overflow = NULL,
  button_size = NULL,
  append_to = NULL
)

Arguments

session: Shiny session; the current one by default, as for shiny::updateTextInput().
id: Input ID the answer is reported to.
message: The question or statement, or a VNode built in the browser: JS() code calling Vue.h(), or a function of the box's actions (confirm, cancel, close) returning one.
title: Title of the box.
type: Icon shown: "success", "info", "warning" or "error".
box_type: "confirm" (default) offers two buttons, "alert" one, and "prompt" asks for text.
confirm_button_text, cancel_button_text: Button labels.
show_cancel_button: Whether to offer a cancel button. Default TRUE for "confirm" and "prompt".
show_close: Whether to show the close cross. Default TRUE.
center: Whether to centre the content.
round_button: Whether the buttons are rounded.
dangerously_use_html_string: Whether message is rendered as HTML. Only pass TRUE for markup you control – it is inserted unescaped.
custom_class: Extra class name.
close_on_click_modal: Whether clicking the backdrop closes it.
close_on_press_escape: Whether Escape closes it.
input_placeholder, input_value: For box_type = "prompt": the placeholder and the initial text.
input_pattern: Regular expression the text must match, as a string.
input_error_message: Message shown when it does not match.
input_type: For a prompt, the input's type, such as "password".
input_validator: For a prompt, JS() function checking the text; return true, or an error message.
show_input: Whether to show a text input, as a prompt does.
show_confirm_button: Whether to show the confirm button.
confirm_button_class, cancel_button_class: Extra class names for the buttons.
distinguish_cancel_and_close: Whether closing by the cross or Escape reports "close" rather than "cancel".
lock_scroll: Whether the page stops scrolling while the box is open.
close_on_hash_change: Whether a change of the URL hash closes it.
before_close: JS() function function(action, instance, done), called before the box closes; call done() to let it.
custom_style: CSS for the box, a string or a named list.
icon, close_icon: The icon shown instead of the one type implies, and the close button's, by name.
confirm_button_type, cancel_button_type: The buttons' types, as el_button()'s type.
confirm_button_loading_icon, cancel_button_loading_icon: The buttons' loading icons, by name.
autofocus: Whether the box takes focus when it opens. Default TRUE.
modal: Whether it has a backdrop. Default TRUE.
modal_class: Extra class name for the backdrop.
draggable: Whether it can be dragged by its header.
overflow: With draggable, whether it can be dragged past the viewport.
button_size: The buttons' size: "small", "default" or "large".
append_to: CSS selector of the element it is appended to. Default <body>.

Value

Called for its side effect; returns NULL invisibly.

Details

Unlike el_message() and el_notification(), this one answers back. The reply arrives as input$<id>, so read it with observeEvent(): the input is set with event priority, so answering "confirm" twice in a row fires the observer twice, where an output reading the value would see no change.

Shiny inputs

input$<id> – "confirm", "cancel" or "close". For a prompt that was confirmed, a list of action and value, where value is the text the user typed.

Examples

if (interactive()) {
  library(shiny)
  library(shiny.element)

  ui <- el_page(
    el_button("del", "Delete", type = "danger"),
    verbatimTextOutput("answer")
  )

  server <- function(input, output, session) {
    observeEvent(input$del, {
      el_message_box(
        session,
        "confirm_delete",
        "This cannot be undone.",
        title = "Delete the row?",
        type = "warning"
      )
    })
    observeEvent(input$confirm_delete, {
      output$answer <- renderPrint(input$confirm_delete)
    })
  }
  shinyApp(ui, server)
}