htmlwidgets: htmlwidgets-shiny – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

htmlwidgets-shiny

Shiny bindings for HTML widgets

Description

Helpers to create output and render functions for using HTML widgets within Shiny applications and interactive Rmd documents.

Usage

shinyWidgetOutput(
  outputId,
  name,
  width,
  height,
  package = name,
  inline = FALSE,
  reportSize = FALSE,
  reportTheme = FALSE
)

shinyRenderWidget(expr, outputFunction, env, quoted, cacheHint = "auto")

Arguments

`outputId`	output variable to read from
`name`	Name of widget to create output binding for
`width, height`	Must be a valid CSS unit (like `"100%"`, `"400px"`, `"auto"`) or a number, which will be coerced to a string and have `"px"` appended.
`package`	Package containing widget (defaults to `name`)
`inline`	use an inline (`span()`) or block container (`div()`) for the output
`reportSize`	Should the widget's container size be reported in the shiny session's client data?
`reportTheme`	Should the widget's container styles (e.g., colors and fonts) be reported in the shiny session's client data?
`expr`	An expression that generates an HTML widget (or a promise of an HTML widget).
`outputFunction`	Shiny output function corresponding to this render function.
`env`	The environment in which to evaluate `expr`.
`quoted`	Is `expr` a quoted expression (with `quote()`)? This is useful if you want to save an expression in a variable.
`cacheHint`	Extra information to use for optional caching using `shiny::bindCache()`.

Details

These functions are delegated to from within your widgets own shiny output and render functions. The delegation is boilerplate and always works the same for all widgets (see example below).

Value

An output or render function that enables the use of the widget within Shiny applications.

Examples

# shiny output binding for a widget named 'foo'
fooOutput <- function(outputId, width = "100%", height = "400px") {
  htmlwidgets::shinyWidgetOutput(outputId, "foo", width, height)
}

# shiny render function for a widget named 'foo'
renderFoo <- function(expr, env = parent.frame(), quoted = FALSE) {
  if (!quoted) { expr <- substitute(expr) } # force quoted
  htmlwidgets::shinyRenderWidget(expr, fooOutput, env, quoted = TRUE)
}

htmlwidgets

HTML Widgets for R

v1.5.3

MIT + file LICENSE

Authors

Ramnath Vaidyanathan [aut, cph], Yihui Xie [aut], JJ Allaire [aut], Joe Cheng [aut], Carson Sievert [aut, cre] (<https://orcid.org/0000-0002-4958-2844>), Kenton Russell [aut, cph], Ellis Hughes [ctb], RStudio [cph]

Initial release