LivePanels.Canvas.Render (livepanels v0.1.0)

Copy Markdown View Source

Render-side helpers for ordinary canvas_runtime/1 applications.

These helpers do not mutate canonical canvas state. They operate on the current LiveView render projection.

Summary

Types

item_ref()

Functions

refresh(socket, items)

Re-sends existing rendered canvas items to the LiveView stream.

Types

item_ref()

@type item_ref() ::
  LivePanels.Item.t()
  | LivePanels.Item.RenderContext.t()
  | LivePanels.Item.View.t()
  | %{id: String.t()}
  | String.t()

Functions

refresh(socket, items)

@spec refresh(Phoenix.LiveView.Socket.t(), item_ref() | [item_ref()]) ::
  Phoenix.LiveView.Socket.t()

Re-sends existing rendered canvas items to the LiveView stream.

Use this when rendered canvas items depend on app assigns outside canonical canvas state. This does not mutate canvas state, history, persistence, or shared-coordination state.