https://github.com/dreamRs/shinybusy

Minimal busy indicator for Shiny apps
https://github.com/dreamRs/shinybusy

shiny

Last synced: 5 months ago
JSON representation

Minimal busy indicator for Shiny apps

• Host: GitHub
• URL: https://github.com/dreamRs/shinybusy
• Owner: dreamRs
• License: other
• Created: 2018-12-17T15:29:35.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-17T07:24:22.000Z (7 months ago)
• Last Synced: 2024-10-27T04:38:44.303Z (6 months ago)
• Topics: shiny
• Language: R
• Homepage: https://dreamrs.github.io/shinybusy/
• Size: 10.8 MB
• Stars: 138
• Watchers: 6
• Forks: 16
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-shiny-extensions - shinybusy - Minimal busy indicator for Shiny apps. (UI Components / Loader)
• jimsghstars - dreamRs/shinybusy - Minimal busy indicator for Shiny apps (R)

README

        
# shinybusy

> Automated (or not) busy indicator for Shiny apps & other progress / notifications tools

[![version](http://www.r-pkg.org/badges/version/shinybusy)](https://CRAN.R-project.org/package=shinybusy)

[![cranlogs](http://cranlogs.r-pkg.org/badges/shinybusy)](https://CRAN.R-project.org/package=shinybusy)

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![R-CMD-check](https://github.com/dreamRs/shinybusy/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/dreamRs/shinybusy/actions/workflows/R-CMD-check.yaml)

[![Codecov test coverage](https://codecov.io/gh/dreamRs/shinybusy/branch/master/graph/badge.svg)](https://app.codecov.io/gh/dreamRs/shinybusy?branch=master)

## Installation

Install from [CRAN](https://cran.r-project.org/package=shinybusy) with:

```r

install.packages("shinybusy")

```

You can install dev version of `shinybusy` from [GitHub](https://github.com/dreamRs/shinybusy):

```r

remotes::install_github("dreamRs/shinybusy")

```

## Examples

### Automated busy indicators

#### Gif

Animate a Gif when server is busy and pause animation when server is idle :

```r

# Somewhere in UI

add_busy_gif(src = "https://jeroen.github.io/images/banana.gif", height = 70, width = 70)

```

![](man/figures/shinybusy-gif.gif)

#### Progress bar

Make an infinite progress bar appear on top of the page when server is busy :

```r

add_busy_bar(color = "#FF0000")

```

![](man/figures/shinybusy-bar.gif)

#### Spinner

Add a spinner when server is busy on top-right corner of the page with:

```r

add_busy_spinner(spin = "fading-circle")

```

![](man/figures/shinybusy-spin.gif)

### Other functionalities

Display a loading indicator at the start of the application until it is ready to be used, block application interaction until a calculation is done, send notifications to user, ... See vignette or [online website](https://dreamrs.github.io/shinybusy/) for more.

## Development

This package use [{packer}](https://github.com/JohnCoene/packer) to manage JavaScript assets, see packer's [documentation](https://packer.john-coene.com/#/) for more.

Install nodes modules with:

```r

packer::npm_install()

```

Modify `srcjs/exts/busy.js` (or other scripts), then run:

```r

packer::bundle()

```

Re-install R package and try demo applications in `examples/`.

## Other related packages

These packages provide cool alternative to add progress indicator in shiny application :

* [{waiter}](https://github.com/JohnCoene/waiter) : Loading screens for Shiny

* [{shinycssloaders}](https://github.com/daattali/shinycssloaders) : Add CSS loader animations to Shiny outputs

* [{shinycustomloader}](https://github.com/emitanaka/shinycustomloader) : Add a custom loader for R shiny

## Acknowledgements

Development of this package was funded by Silex Technologies (https://www.silex-ip.com)