linkeR (version 0.1.2)

create_link_registry: Create a Link Registry for 'shiny' Component Coordination

Description

create_link_registry creates a registry system that manages linked interactions between multiple 'shiny' components, allowing them to share selection state and coordinate their behavior.

Usage

create_link_registry(session, on_selection_change = NULL)

Value

A link_registry object with the following methods:

register_component(session, component_id, type, data_reactive, shared_id_column, config)

Register a new component with the registry. Parameters:

• session: 'shiny' session object for namespacing. Can be global session in non-modular apps.

• component_id: Unique string identifier for the component

• type: Component type (e.g., "table", "plot")

• data_reactive: Reactive expression returning the component's data

• shared_id_column: Name of the column used for linking selections

• config: Optional list of component-specific configuration

clear_all()

Remove all registered components and reset shared state

set_selection(selected_id, source_component_id)

Programmatically update the selection state

get_selection()

Get current selection as list with selected_id and source

get_on_selection_change()

Return the on_selection_change callback function

get_components()

Get registry components info (for debugging)

get_shared_state()

Get current shared state (for debugging)

Arguments

session

A 'shiny' session object, required for server-side reactivity

on_selection_change

Optional callback function that gets called when selection changes. Should accept parameters: selected_id, selected_data, source_component_id, and session

Details

The registry maintains a shared state across all registered components, automatically setting up observers to synchronize selections. When a selection changes in one component, all other registered components are updated to reflect the same selection.

Components are automatically cleaned up when re-registered to prevent memory leaks from orphaned observers.

See Also

setup_component_observers() for component observer setup

Examples

# \donttest{
# Create a mock session for the example
session <- shiny::MockShinySession$new()

# Create registry with optional callback
registry <- create_link_registry(
  session = session,
  on_selection_change = function(id, data, source, session) {
    message("Selection changed to ID: ", id, " from: ", source)
  }
)

# In a real app, you would register components like this:
# my_data <- reactive({ data.frame(id = 1:3, name = c("A", "B", "C")) })
# registry$register_component("table1", "table", my_data, "id")
# registry$register_component("plot1", "plot", my_data, "id")
# }