Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bindings can't be registered asynchronously #3635

Open
cpsievert opened this issue May 16, 2022 · 2 comments · May be fixed by #3638
Open

Bindings can't be registered asynchronously #3635

cpsievert opened this issue May 16, 2022 · 2 comments · May be fixed by #3638

Comments

@cpsievert
Copy link
Collaborator

cpsievert commented May 16, 2022 •
edited

Consider a basic input binding:

# app.R
library(shiny)

incrementButton <- function(inputId, value = 0) {
  tagList(
    tags$head(tags$script(src = "increment.js")),
    tags$button(id = inputId,
                class = "increment btn btn-default",
                type = "button",
                as.character(value))
  )
}

ui <- fluidPage(
  incrementButton("foo"),
  textOutput("foo_value")
)

server <- function(input, output, session) {
  output$foo_value <- renderText({
    paste("Clicked this many times:", input$foo)
  })
}


shinyApp(ui, server)
// www/increment.js

$(document).on("click", "button.increment", function(evt) {

  // evt.target is the button that was clicked
  var el = $(evt.target);

  // Set the button's text to its current value plus 1
  el.text(parseInt(el.text()) + 1);

  // Raise an event to signal that the value changed
  el.trigger("change");
});

var incrementBinding = new Shiny.InputBinding();
$.extend(incrementBinding, {
  find: function(scope) {
    return $(scope).find(".increment");
  },
  getValue: function(el) {
    return parseInt($(el).text());
  },
  setValue: function(el, value) {
    $(el).text(value);
  },
  subscribe: function(el, callback) {
    $(el).on("change.incrementBinding", function(e) {
      callback();
    });
  },
  unsubscribe: function(el) {
    $(el).off(".incrementBinding");
  }
});

Now, if we register synchronously all is fine, but not if we register in a setTimeout(), the binding doesn't bind to the DOM:

setTimeout(() => { Shiny.inputBindings.register(incrementBinding); }, 100);

That use case may seem contrived, but becomes a real problem if you're trying to load JS dependencies asynchronously (e.g., via requirejs) to define/register the binding:

incrementButton <- function(inputId, value = 0) {
  tagList(
    tags$head(
      tags$script(src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js"
      tags$script(src = "increment.js")
    ),
    tags$button(id = inputId,
                class = "increment btn btn-default",
                type = "button",
                as.character(value))
  )
}
require.config({paths: {"lodash": "https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.4/lodash.min"}});
require(["lodash"], function(_) {
  const finalBinding = _.last([incrementBinding]);
  Shiny.inputBindings.register(finalBinding);
})
cpsievert added a commit that referenced this issue May 17, 2022
@cpsievert
Close #3635: attempt another bind after registering a binding
5eb5001
cpsievert added a commit that referenced this issue May 18, 2022
@cpsievert
Close #3635: attempt another bind when registering a binding outside …
c163286 
…a renderHtml() context
@cpsievert cpsievert linked a pull request May 18, 2022 that will close this issue
Open
cpsievert added a commit that referenced this issue May 18, 2022
@cpsievert
Close #3635: attempt another bind when registering a binding outside …
fe803e0 
…a renderHtml() context
@cpsievert cpsievert mentioned this issue May 23, 2022
Closed
cpsievert added a commit that referenced this issue Jun 14, 2022
@cpsievert
Close #3635: attempt another bind when registering a binding outside …
8221d5f 
…a renderHtml() context
cpsievert added a commit that referenced this issue Jul 7, 2022
@cpsievert
Close #3635: attempt another bind when registering a binding outside …
7bccfeb 
…a renderHtml() context
@cpsievert cpsievert mentioned this issue Mar 31, 2023
Closed
@cpsievert
Copy link
Collaborator Author

For posterity, with Shiny>1.7.4, one can workaround this issue by adding this right after registering the binding (as was done in posit-dev/py-shinywidgets#91)

Shiny.shinyapp.taskQueue.enqueue(() => Shiny.bindAll(document.body));

@wch
Copy link
Collaborator

wch commented Mar 31, 2023

Update: see version in posit-dev/py-shinywidgets#93

I think it can actually be simplified to:

Shiny.shinyapp?.taskQueue?.enqueue(() => Shiny.bindAll(document.body));

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Attempt another bind when registering a binding outside a renderHtml() context rstudio/shiny
2 participants
@wch @cpsievert