Title:	Add Loading Animations to a 'shiny' Output While It's Recalculating
Version:	1.1.0
Description:	When a 'Shiny' output (such as a plot, table, map, etc.) is recalculating, it remains visible but gets greyed out. Using 'shinycssloaders', you can add a loading animation ("spinner") to outputs instead. By wrapping a 'Shiny' output in 'withSpinner()', a spinner will automatically appear while the output is recalculating. You can also manually show and hide the spinner, or add a full-page spinner to cover the entire page. See the demo online at https://daattali.com/shiny/shinycssloaders-demo/.
License:	MIT + file LICENSE
URL:	https://github.com/daattali/shinycssloaders, https://daattali.com/shiny/shinycssloaders-demo/
BugReports:	https://github.com/daattali/shinycssloaders/issues
Depends:	R (≥ 3.1)
Imports:	digest, glue, grDevices, htmltools (≥ 0.3.5), shiny
Suggests:	knitr, shinydisconnect, shinyjs
RoxygenNote:	7.2.3
Encoding:	UTF-8
NeedsCompilation:	no
Packaged:	2024-07-30 18:52:48 UTC; Dean
Author:	Dean Attali [aut, cre] (Maintainer/developer of shinycssloaders since 2019), Andras Sali [aut] (Original creator of shinycssloaders package), Luke Hass [ctb, cph] (Author of included CSS loader code)
Maintainer:	Dean Attali <daattali@gmail.com>
Repository:	CRAN
Date/Publication:	2024-07-30 22:30:02 UTC

shinycssloaders: Add Loading Animations to a 'shiny' Output While It's Recalculating

Description

When a 'Shiny' output (such as a plot, table, map, etc.) is recalculating, it remains visible but gets greyed out. Using 'shinycssloaders', you can add a loading animation ("spinner") to outputs instead. By wrapping a 'Shiny' output in 'withSpinner()', a spinner will automatically appear while the output is recalculating. You can also manually show and hide the spinner, or add a full-page spinner to cover the entire page. See the demo online at https://daattali.com/shiny/shinycssloaders-demo/.

Author(s)

Maintainer: Dean Attali daattali@gmail.com (ORCID) (Maintainer/developer of shinycssloaders since 2019)

Authors:

• Andras Sali andras.sali@alphacruncher.hu (Original creator of shinycssloaders package)

Other contributors:

• Luke Hass (Author of included CSS loader code) [contributor, copyright holder]

See Also

Useful links:

• https://github.com/daattali/shinycssloaders

• https://daattali.com/shiny/shinycssloaders-demo/

• Report bugs at https://github.com/daattali/shinycssloaders/issues

Manually show/hide a spinner

Description

Any Shiny output that uses withSpinner() will automatically show a spinner while it's recalculating. Use showSpinner() and hideSpinner() to manually trigger the spinner on-demand.

Usage

showSpinner(id, expr)

hideSpinner(id)

Arguments

Value

If expr is provided, the result of expr is returned. Otherwise, NULL.

See Also

withSpinner()

Examples

if (interactive()) {
  library(shiny)

  #--- Example 1: Using showSpinner/hideSpinner ---

  shinyApp(
    ui = fluidPage(
      actionButton("show", "Show"),
      actionButton("hide", "Hide"),
      withSpinner(plotOutput("plot"))
    ),
    server = function(input, output) {
      output$plot <- renderPlot({
        plot(runif(10))
      })
      observeEvent(input$show, {
        showSpinner("plot")
      })
      observeEvent(input$hide, {
        hideSpinner("plot")
      })
    }
  )

  #--- Example 2: Using showSpinner with expr ---

  some_slow_function <- function() {
    Sys.sleep(2)
  }

  shinyApp(
    ui = fluidPage(
      actionButton("show", "Show"),
      withSpinner(plotOutput("plot"))
    ),
    server = function(input, output) {
      output$plot <- renderPlot({
        plot(runif(10))
      })
      observeEvent(input$show, {
        showSpinner("plot", { some_slow_function() })
      })
    }
  )
}

Show (and hide) a full-page spinner that covers the entire page

Description

Use these functions to show and hide a full-page spinner.

All parameters (except expr) can be set globally in order to use a default setting for all full-page spinner in your Shiny app. This can be done by setting an R option with the parameter's name prepended by "page.spinner.". For example, to set all page spinners to type=5 and color=#0dc5c1 by default, use options(page.spinner.type = 5, page.spinner.color = "#0dc5c1").

Usage

showPageSpinner(
  expr,
  background = getOption("page.spinner.background", default = "#FFFFFFCC"),
  type = getOption("page.spinner.type", default = 8),
  color = getOption("page.spinner.color", default = "#0275D8"),
  size = getOption("page.spinner.size", default = 1),
  color.background = getOption("page.spinner.color.background"),
  custom.css = getOption("page.spinner.custom.css", default = FALSE),
  id = getOption("page.spinner.id"),
  image = getOption("page.spinner.image"),
  image.width = getOption("page.spinner.image.width"),
  image.height = getOption("page.spinner.image.height"),
  caption = getOption("page.spinner.caption")
)

hidePageSpinner()

Arguments

Value

If expr is provided, the result of expr is returned. Otherwise, NULL.

See Also

withSpinner(), showSpinner(), hideSpinner()

Examples

if (interactive()) {
  library(shiny)

  #--- Example 1: Using showPageSpinner/hidePageSpinner ---

  ui <- fluidPage(
    actionButton("go", "Go"),
    plotOutput("plot")
  )
  server <- function(input, output) {
    observeEvent(input$go, {
      showPageSpinner()
      Sys.sleep(1)
      hidePageSpinner()
    })
    output$plot <- renderPlot({
     plot(runif(10))
    })
  }
  shinyApp(ui, server)

  #--- Example 2: Using showPageSpinner with expr ---

  some_slow_function <- function() {
    Sys.sleep(1)
  }

  ui <- fluidPage(
    actionButton("go", "Go"),
    plotOutput("plot")
  )
  server <- function(input, output) {
    observeEvent(input$go, {
      showPageSpinner({ some_slow_function() })
    })
    output$plot <- renderPlot({
     plot(runif(10))
    })
  }
  shinyApp(ui, server)
}

Add a spinner that shows while an output is recalculating

Description

Add a spinner that automatically shows while an output is recalculating. You can also manually trigger the spinner using showSpinner() and hideSpinner().

Most parameters can be set globally in order to use a default setting for all spinners in your Shiny app. This can be done by setting an R option with the parameter's name prepended by "spinner.". For example, to set all spinners to type=5 and color=#0dc5c1 by default, use options(spinner.type = 5, spinner.color = "#0dc5c1"). The following parameters cannot be set globally: ui_element, id.

Use showPageSpinner() to show a spinner on the entire page instead of individual outputs.

Usage

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 = getOption("spinner.custom.css", default = FALSE),
  proxy.height = getOption("spinner.proxy.height"),
  id = NULL,
  image = getOption("spinner.image"),
  image.width = getOption("spinner.image.width"),
  image.height = getOption("spinner.image.height"),
  hide.ui = getOption("spinner.hide.ui", default = TRUE),
  caption = getOption("spinner.caption")
)

Arguments

See Also

showSpinner(), hideSpinner(), showPageSpinner()

Examples

if (interactive()) {
  library(shiny)

  shinyApp(
    ui = fluidPage(
      actionButton("go", "Go"),
      withSpinner(plotOutput("plot"))
    ),
    server = function(input, output) {
      output$plot <- renderPlot({
        input$go
        Sys.sleep(1.5)
        plot(runif(10))
      })
    }
  )
}