Function set_props

dash/_callback_context.py:361–386

Set the props for a component not included in the callback outputs. If running in a WebSocket context, props are streamed immediately to the client. Otherwise, props are batched and sent with the callback response.

(component_id: typing.Union[str, dict], props: dict)

def set_props(component_id: typing.Union[str, dict], props: dict):
    """
    Set the props for a component not included in the callback outputs.

    If running in a WebSocket context, props are streamed immediately to the
    client. Otherwise, props are batched and sent with the callback response.
    """
    ws = _get_from_context("dash_websocket", None)
    if ws is not None:
        # Stream immediately via WebSocket
        _id = stringify_id(component_id)

        async def _send_props():
            for prop_name, value in props.items():
                await ws.set_prop(_id, prop_name, value)

        # If we're in an async context, schedule the coroutine
        try:
            asyncio.get_running_loop()
            asyncio.ensure_future(_send_props())
        except RuntimeError:
            # No running event loop - run synchronously
            asyncio.run(_send_props())
    else:
        # Batch for response (existing behavior)
        callback_context.set_props(component_id, props)