LivePanels.Toolkit.Integration.ProtocolAttrs (livepanels v0.1.0)

Copy Markdown View Source

Command-envelope attrs for integration code.

Prefer named control helpers such as add_item_attrs/2, remove_item_attrs/2, graph attrs, and drawing control attrs for application UI. Use this module when a bridge package or custom surface deliberately constructs a lower-level runtime command envelope.

Summary

Types

item_ref()

Functions

command_attrs(command, overrides \\ %{})

Returns attrs for a command-envelope application control with no item id.

item_command_attrs(command, item_or_id, overrides \\ %{})

Returns attrs for a command-envelope application control targeting one item.

Types

item_ref()

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

Functions

command_attrs(command, overrides \\ %{})

@spec command_attrs(atom() | String.t(), keyword() | map()) :: map()

Returns attrs for a command-envelope application control with no item id.

item_command_attrs(command, item_or_id, overrides \\ %{})

@spec item_command_attrs(atom() | String.t(), item_ref(), keyword() | map()) :: map()

Returns attrs for a command-envelope application control targeting one item.