shinybusy

repository·master·Indexed 41 days ago

https://github.com/dreamrs/shinybusy

An R package for Shiny applications providing automated or manual busy indicators, progress bars, and notifications. Version 1.0.0 includes functions like add_busy_gif(), add_busy_bar(), and add_busy_spinner() to improve user experience during long-running server tasks.

Tokens
505
Snippets
4
Records
5
Agent score
0%

What's inside shinybusy

  1. Overview of shinybusy functionalities

    master

    Beyond automated busy indicators, shinybusy provides tools to:

    • Display a loading indicator at the start of the application until it is ready.
    • Block application interaction while a calculation is in progress.
    • Send notifications to the user.

    For more detailed information, refer to the package vignette or the online website.

  2. Install shinybusy

    master

    You can install the stable version of shinybusy from CRAN or the development version from GitHub.

    From CRAN:

    install.packages("shinybusy")

    From GitHub (Development version):

    remotes::install_github("dreamRs/shinybusy")
  3. Add an animated GIF busy indicator

    master

    Use add_busy_gif() to animate a GIF when the Shiny server is busy and automatically pause the animation when the server is idle. This function should be called within the UI part of your Shiny application.

    Parameters:

    • src: The URL or path to the GIF image.
    • height: The height of the GIF.
    • width: The width of the GIF.
    # Somewhere in UI
    add_busy_gif(src = "https://jeroen.github.io/images/banana.gif", height = 70, width = 70)
  4. Add an infinite progress bar busy indicator

    master

    Use add_busy_bar() to make an infinite progress bar appear at the top of the page whenever the server is busy. This function should be called within the UI part of your Shiny application.

    Parameters:

    • color: The color of the progress bar (e.g., hex code).
    # Somewhere in UI
    add_busy_bar(color = "#FF0000")
  5. Add a spinner busy indicator

    master

    Use add_busy_spinner() to add a spinner in the top-right corner of the page when the server is busy. This function should be called within the UI part of your Shiny application.

    Parameters:

    • spin: The type of spinner animation (e.g., "fading-circle").
    # Somewhere in UI
    add_busy_spinner(spin = "fading-circle")