Sanity Library Reference Docs
    Preparing search index...

    Type Alias VisualEditingControllerMsg

    VisualEditingControllerMsg:
        | { data: { id: string; path: string }; type: "presentation/focus" }
        | { data: undefined; type: "presentation/blur" }
        | { data: HistoryUpdate; type: "presentation/navigate" }
        | { data: undefined; type: "presentation/toggle-overlay" }
        | { data: HistoryRefresh; type: "presentation/refresh" }
        | {
            data: { perspective: ClientPerspective };
            type: "presentation/perspective";
        }
        | { data: { schema: SchemaType[] }; type: "presentation/schema" }
        | {
            data: { snapshots: PreviewSnapshot[] };
            type: "presentation/preview-snapshots";
        }
        | {
            data: { event: ReconnectEvent
            | WelcomeEvent
            | MutationEvent_2 };
            type: "presentation/snapshot-event";
        }
        | {
            data: { key: string; value?: Serializable };
            type: "presentation/shared-state";
        }
        | { data: undefined; type: "presentation/status" }

    Type declaration

    • { data: { id: string; path: string }; type: "presentation/focus" }
    • { data: undefined; type: "presentation/blur" }
    • { data: HistoryUpdate; type: "presentation/navigate" }
    • { data: undefined; type: "presentation/toggle-overlay" }
    • { data: HistoryRefresh; type: "presentation/refresh" }
    • { data: { perspective: ClientPerspective }; type: "presentation/perspective" }
    • { data: { schema: SchemaType[] }; type: "presentation/schema" }
    • {
          data: { snapshots: PreviewSnapshot[] };
          type: "presentation/preview-snapshots";
      }
    • {
          data: { event: ReconnectEvent | WelcomeEvent | MutationEvent_2 };
          type: "presentation/snapshot-event";
      }
    • {
          data: { key: string; value?: Serializable };
          type: "presentation/shared-state";
      }
    • { data: undefined; type: "presentation/status" }
      • data: undefined
      • type: "presentation/status"

        Special event where Presentation Tool is unable to connect to a target iframe or popup window, and is asking for status with targetOrigin: * to detect if the URL origin is misconfigured. Presentation doesn't send any data, as any listener can see it.