daattali/shinyjs

Add support for Shiny JS events

Open

#168 opened on Jun 8, 2018

View on GitHub
 (8 comments) (1 reaction) (0 assignees)R (521 stars) (104 forks)batch import
enhancementhelp wanted

Description

Hi Dean, long time no see ;) I can't say that enough: your package is awesome! The only thing I'm currently missing is the support for Shiny events. Right now I'm implementing king of a busy indicator which can be easily set-up with a custom JS code as shown in the example. Yet, it would be really great if something along the following lines would be possible - what do you think?

Cheers, Andrzej

library(shinyjs)

shinyApp(
  ui = fluidPage(
    useShinyjs(),
    ...
    div(id = "loader")
    ),
  server = function(input, output) {
    ...
    onshiny("busy", show("loader"))
    onshiny("idle", hide("loader"))
  }
)

Contributor guide

Tech stack
javascript
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
RShinyJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
The issue requests adding support for Shiny JS events to shinyjs. The example shows how to use onshiny() to show/hide elements on busy/idle events. To implement, one would need to extend shinyjs to register JavaScript event handlers. Review the existing shinyjs source code (likely R/ and inst/ directories) to understand how JavaScript functions are added. Also consult Shiny's JavaScript events documentation (https://shiny.rstudio.com/articles/js events.html) to ensure proper integration. The discussion in the issue comments may provide further guidance on expected API design.