R/show_rcode_modal.R

In teal: Exploratory Web Apps for Analyzing Clinical Trials Data

#' Show `R` code modal
#'
#' @description `r lifecycle::badge("deprecated")`
#'
#' Use the [shiny::showModal()] function to show the `R` code inside.
#'
#' @param title (`character(1)`)
#'  Title of the modal, displayed in the first comment of the `R` code.
#' @param rcode (`character`)
#'  vector with `R` code to show inside the modal.
#' @param session (`ShinySession`) optional
#'  `shiny` session object, defaults to [shiny::getDefaultReactiveDomain()].
#'
#' @references [shiny::showModal()]
#' @export
show_rcode_modal <- function(title = NULL, rcode, session = getDefaultReactiveDomain()) {
  lifecycle::deprecate_soft(
    when = "0.16.0",
    what = "show_rcode_modal()",
    details = "This function will be removed in the next release."
  )

  rcode <- paste(rcode, collapse = "\n")

  ns <- session$ns
  showModal(modalDialog(
    tagList(
      tags$div(
        actionButton(
          ns("copyRCode"),
          "Copy to Clipboard",
          onclick = sprintf("copyToClipboard('%s')", ns("r_code"))
        ),
        modalButton("Dismiss")
      ),
      tags$div(tags$pre(id = ns("r_code"), rcode)),
    ),
    title = title,
    footer = tagList(
      actionButton(
        ns("copyRCode"),
        "Copy to Clipboard",
        onclick = sprintf("copyToClipboard('%s')", ns("r_code"))
      ),
      modalButton("Dismiss")
    ),
    size = "l",
    easyClose = TRUE
  ))
}