A2UIPhoenix.Context (A2UIPhoenix v0.1.1)

What a component needs to render inside a surface.

:surface_id, :surface and :resolver — the surface and its resolved tree (A2UICore.Resolution.NodeResolver);
:components — the component map, %{type => function_component};
:target — the phx-target of the surface's events (the A2UIPhoenix.Surface LiveComponent);
:ui — the surface's local UI state by node ref (the open tab, an open modal, a choice filter); never sent to the agent;
:markdown — an optional (String.t() -> Phoenix.HTML.safe()) used for body text (nil renders text as is);
:mcp_sandbox — the URL of the MCP App sandbox proxy page (nil uses A2UIPhoenix.Components.MCP.default_sandbox/0).

Custom components receive it as @ctx and use the helpers below to name their inputs and DOM ids the way the surface expects.

Summary

Types

t()

Functions

dom_id(ctx, node, suffix \\ nil)

A DOM id for node, unique on the page while the node is mounted; suffix names an element inside the component.

input_name(node, field \\ "value")

The form name of an input of node: field is the component property the input writes ("value" by default).

node(context, ref)

The mounted node with ref, or nil.

ui(context, node, key, default)

A value of the local UI state of node, or default.

Types

t()

(since 0.1.0)

@type t() :: %A2UIPhoenix.Context{
  components: %{
    optional(String.t()) => (map() -> Phoenix.LiveView.Rendered.t())
  },
  markdown: (String.t() -> Phoenix.HTML.safe()) | nil,
  mcp_sandbox: String.t() | nil,
  resolver: A2UICore.Resolution.NodeResolver.t() | nil,
  surface: A2UICore.State.Surface.t() | nil,
  surface_id: String.t() | nil,
  target: term(),
  ui: %{optional(pos_integer()) => map()}
}

Functions

dom_id(ctx, node, suffix \\ nil)

(since 0.1.0)

@spec dom_id(t(), A2UICore.Resolution.Node.t() | pos_integer(), String.t() | nil) ::
  String.t()

A DOM id for node, unique on the page while the node is mounted; suffix names an element inside the component.

iex> ctx = %A2UIPhoenix.Context{surface_id: "main form"}
iex> A2UIPhoenix.Context.dom_id(ctx, 7, "input")
"a2ui-main_form-7-input"

input_name(node, field \\ "value")

(since 0.1.0)

@spec input_name(A2UICore.Resolution.Node.t() | pos_integer(), String.t()) ::
  String.t()

The form name of an input of node: field is the component property the input writes ("value" by default).

iex> A2UIPhoenix.Context.input_name(7)
"a2ui[7][value]"

node(context, ref)

(since 0.1.0)

@spec node(t(), pos_integer()) :: A2UICore.Resolution.Node.t() | nil

The mounted node with ref, or nil.

ui(context, node, key, default)

(since 0.1.0)

@spec ui(t(), A2UICore.Resolution.Node.t(), atom(), term()) :: term()

A value of the local UI state of node, or default.