Nothing
R/utils.R
In shinyjs: Easily Improve the User Experience of Your Shiny Apps in Seconds
Defines functions
shinyjsFunctionNames
shinyjsInlineScript
shinyjsInlcudeScript
insertHead
setupJS
getSession
errMsg
# common way to print error messages
errMsg <- function(x) {
stop(sprintf("shinyjs: %s", x), call. = FALSE)
}
# get the shiny session object
getSession <- function() {
session <- shiny::getDefaultReactiveDomain()
if (is.null(session)) {
errMsg(paste(
"could not find the Shiny session object. This usually happens when a",
"shinyjs function is called from a context that wasn't set up by a Shiny session."
))
}
session
}
# set up some javascript functions to work with shinyjs and any other resources
setupJS <- function(jsFuncs, script, text, ...) {
# add a shiny message handler binding for each supported method
tpl <- paste0(
"Shiny.addCustomMessageHandler('shinyjs-%s', function(params) {",
" shinyjs.debugMessage('shinyjs: calling function \"%s\" with parameters:');",
" shinyjs.debugMessage(params);",
" shinyjs.%s(params);",
"});")
controllers <-
lapply(jsFuncs, function(x) {
sprintf(tpl, x, x, x)})
controllers <- paste(controllers, collapse = "\n")
# ensure the same scripts don't get added to the HTML twice
shinyjsContent <-
shiny::singleton(
insertHead(
# add the message handlers
shiny::tags$script(shiny::HTML(controllers)),
# add the actual javascript code
shinyjsInlcudeScript(script),
shinyjsInlineScript(text),
# add any extra tags
...
)
)
# inject the content via JavaScript if necessary
if (!is.null(.globals$inject) && .globals$inject) {
shinyjsContent <- as.character(shinyjsContent)
session <- getSession()
session$sendCustomMessage('shinyjs-inject', shinyjsContent)
} else {
shinyjsContent
}
}
# insert content into the <head> tag of the document if this is a proper HTML
# Shiny app, but if it's inside an interactive Rmarkdown document then don't
# use <head> as it won't work
insertHead <- function(...) {
if (is.null(.globals$astext) || .globals$astext) {
shiny::tagList(...)
} else {
shiny::tags$head(...)
}
}
# include a JavaScript script
shinyjsInlcudeScript <- function(script) {
if (missing(script) || is.null(script)) {
return(NULL)
} else {
shiny::tags$script(src = script)
}
}
# include a JavaScript string
shinyjsInlineScript <- function(text) {
if (missing(text) || is.null(text)) {
return(NULL)
} else {
shiny::tags$script(shiny::HTML(text))
}
}
# names of JS functions defined by shinyjs
shinyjsFunctionNames <- function(type = c("all", "core")) {
type <- match.arg(type)
# core functions are defined in JS and exported in R
jsFuncs <- c(
"show", "hide", "toggle", "enable", "disable", "toggleState",
"addClass", "removeClass", "toggleClass", "html", "onevent", "removeEvent",
"alert", "logjs", "runjs", "reset", "delay", "click", "refresh"
)
if (type == "all") {
jsFuncs <- c(
jsFuncs,
# additional functions which are only defined on the JS side
"debug", "debugMessage", "getParams", "initShinyjs"
)
}
jsFuncs
}
Try the shinyjs package in your browser
Any scripts or data that you put into this service are public.
shinyjs documentation built on Dec. 23, 2021, 5:06 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Defines functions shinyjsFunctionNames shinyjsInlineScript shinyjsInlcudeScript insertHead setupJS getSession errMsg
# common way to print error messages
errMsg <- function(x) {
stop(sprintf("shinyjs: %s", x), call. = FALSE)
}
# get the shiny session object
getSession <- function() {
session <- shiny::getDefaultReactiveDomain()
if (is.null(session)) {
errMsg(paste(
"could not find the Shiny session object. This usually happens when a",
"shinyjs function is called from a context that wasn't set up by a Shiny session."
))
}
session
}
# set up some javascript functions to work with shinyjs and any other resources
setupJS <- function(jsFuncs, script, text, ...) {
# add a shiny message handler binding for each supported method
tpl <- paste0(
"Shiny.addCustomMessageHandler('shinyjs-%s', function(params) {",
" shinyjs.debugMessage('shinyjs: calling function \"%s\" with parameters:');",
" shinyjs.debugMessage(params);",
" shinyjs.%s(params);",
"});")
controllers <-
lapply(jsFuncs, function(x) {
sprintf(tpl, x, x, x)})
controllers <- paste(controllers, collapse = "\n")
# ensure the same scripts don't get added to the HTML twice
shinyjsContent <-
shiny::singleton(
insertHead(
# add the message handlers
shiny::tags$script(shiny::HTML(controllers)),
# add the actual javascript code
shinyjsInlcudeScript(script),
shinyjsInlineScript(text),
# add any extra tags
...
)
)
# inject the content via JavaScript if necessary
if (!is.null(.globals$inject) && .globals$inject) {
shinyjsContent <- as.character(shinyjsContent)
session <- getSession()
session$sendCustomMessage('shinyjs-inject', shinyjsContent)
} else {
shinyjsContent
}
}
# insert content into the <head> tag of the document if this is a proper HTML
# Shiny app, but if it's inside an interactive Rmarkdown document then don't
# use <head> as it won't work
insertHead <- function(...) {
if (is.null(.globals$astext) || .globals$astext) {
shiny::tagList(...)
} else {
shiny::tags$head(...)
}
}
# include a JavaScript script
shinyjsInlcudeScript <- function(script) {
if (missing(script) || is.null(script)) {
return(NULL)
} else {
shiny::tags$script(src = script)
}
}
# include a JavaScript string
shinyjsInlineScript <- function(text) {
if (missing(text) || is.null(text)) {
return(NULL)
} else {
shiny::tags$script(shiny::HTML(text))
}
}
# names of JS functions defined by shinyjs
shinyjsFunctionNames <- function(type = c("all", "core")) {
type <- match.arg(type)
# core functions are defined in JS and exported in R
jsFuncs <- c(
"show", "hide", "toggle", "enable", "disable", "toggleState",
"addClass", "removeClass", "toggleClass", "html", "onevent", "removeEvent",
"alert", "logjs", "runjs", "reset", "delay", "click", "refresh"
)
if (type == "all") {
jsFuncs <- c(
jsFuncs,
# additional functions which are only defined on the JS side
"debug", "debugMessage", "getParams", "initShinyjs"
)
}
jsFuncs
}
Try the shinyjs package in your browser
Any scripts or data that you put into this service are public.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.