sendToIframe() — ui Function Reference

Architecture documentation for the sendToIframe() function in use-iframe-sync.tsx from the ui codebase.

Function tsx DocumentationAtlas Changelog

Entity Profile

DocumentationAtlas→ Changelog→ sendToIframe() — ui Function Reference

Dependency Diagram

graph TD
  2e9d6ea2_8d1c_2495_b9ff_93a07749eb47["sendToIframe()"]
  6df3b824_805c_9704_1ce4_b3b332c22d53["use-iframe-sync.tsx"]
  2e9d6ea2_8d1c_2495_b9ff_93a07749eb47 -->|defined in| 6df3b824_805c_9704_1ce4_b3b332c22d53
  style 2e9d6ea2_8d1c_2495_b9ff_93a07749eb47 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/v4/app/(create)/hooks/use-iframe-sync.tsx lines 44–63

export function sendToIframe<
  Message extends ParentToIframeMessage,
  MessageType extends Message["type"],
>(
  iframe: HTMLIFrameElement | null,
  messageType: MessageType,
  data: Extract<Message, { type: MessageType }>["data"]
) {
  if (!iframe?.contentWindow) {
    return
  }

  iframe.contentWindow.postMessage(
    {
      type: messageType,
      data,
    },
    "*"
  )
}