withSpinner: Add a spinner (loader) that shows when an output is...

Description Usage Arguments Examples

View source: R/withSpinner.R

Description

Add a spinner (loader) that shows when an output is recalculating

Usage

1
2
3
4
5
6
withSpinner(ui_element, type = getOption("spinner.type", default = 1),
  color = getOption("spinner.color", default = "#0275D8"),
  size = getOption("spinner.size", default = 1),
  color.background = getOption("spinner.color.background"),
  custom.css = FALSE, proxy.height = if (grepl("height:\\s*\\d",
  ui_element)) NULL else "400px")

Arguments

ui_element

A UI element that should be wrapped with a spinner when the corresponding output is being calculated.

type

The type of spinner to use, valid values are integers between 1-8. They correspond to the enumeration in https://projects.lukehaas.me/css-loaders/

color

The color of the spinner to be applied in HTML in hex format

size

The size of the spinner, relative to it's default size.

color.background

For certain spinners (type 2-3), you will need to specify the background colour of the spinner

custom.css

If custom css is to be applied, we don't enforce the color / size options to the given spinner id

proxy.height

If the output doesn't specify the output height, you can set a proxy height. It defaults to 400px for outputs with undefined height.

Examples

1
## Not run: withSpinner(plotOutput("my_plot"))

Example output



shinycssloaders documentation built on May 29, 2017, 8:27 p.m.