R/js.R

In ThinkR-open/prague: Where 'golems' Come to Life

#' Interact with JavaScript built-in Functions
#'
#' \code{activate_js} is used in your UI to insert directly the JavaScript
#' functions contained in golem. These functions can be called from
#' the server with \code{invoke_js}. \code{invoke_js} can also be used
#' to launch any JS function created inside a Shiny JavaScript handler.
#'
#' @param fun JS function to be invoked.
#' @param ... JSON-like messages to be sent to the triggered JS function
#' @param session The shiny session within which to call \code{sendCustomMessage}.
#'
#'
#' \describe{
#'   \item{show}{Show an element with the jQuery selector provided.}
#'   \item{hide}{Hide an element with the jQuery selector provided.}
#'   \item{showid}{Show an element with the id provided.}
#'   \item{hideid}{Hide an element with the id provided.}
#'   \item{showclass}{Same as showid, but with class.}
#'   \item{hideclass}{Same as hideid, but with class.}
#'   \item{showhref}{Same as showid, but with `a[href*=`}
#'   \item{hidehref}{Same as hideid, but with `a[href*=`}
#'   \item{clickon}{Click on an element. The full jQuery selector has to be used.}
#'   \item{disable}{Add "disabled" to an element. The full jQuery selector has to be used.}
#'   \item{reable}{Remove "disabled" from an element. The full jQuery selector has to be used.}
#'   \item{alert}{Open an alert box with the message provided.}
#'   \item{prompt}{Open a prompt box with the message provided.}
#'   \item{confirm}{Open a confirm box with the message provided.}
#' }
#'
#' @export
#' @rdname golem_js
#' @importFrom shiny includeScript

activate_js <- function(){
  includeScript(
    system.file(
      "utils/golem-js.js",
      package = "prague"
    )
  )
}

#' @export
#' @rdname golem_js
invoke_js <- function(
  fun,
  ...,
  session = shiny::getDefaultReactiveDomain()
){
  if (fun == ""){
    stop("Error: Empty string is not a valid JS handler name")
  }

  messages <- list(...)
  res <- lapply(
    messages,
    function(message, fun){
      session$sendCustomMessage(fun, message)
    },
    fun=fun
  )
  invisible(res)
}