Send a custom message to client React components

Messages are consumed by useShinyMessageHandler(id, handler) on the React side. The id is namespaced to the current Shiny module (if any) so module-scoped handlers match, just like input/output ids.

Usage

send_message(session, id, data)

Arguments

session

The Shiny session.

id

Message id; must match the id passed to useShinyMessageHandler() in the React component.

data

Any JSON-serializable data.

Value

Invisibly NULL.

Examples

# Paired with useShinyMessageHandler("notify", (msg) => ...) on the client.
server <- function(input, output, session) {
  shiny::observeEvent(input$save, {
    send_message(session, "notify", list(text = "Saved", level = "success"))
  })
}

if (interactive()) {
  shiny::shinyApp(page_react(), server)
}