Sanity Library Reference Docs
    Preparing search index...

    Interface PreviewProps

    interface PreviewProps {
        canSharePreviewAccess: boolean;
        canToggleSharePreviewAccess: boolean;
        canUseSharedPreviewAccess: boolean;
        header?: HeaderOptions;
        initialUrl: URL;
        loadersConnection: ConnectionStatus;
        navigatorEnabled: boolean;
        onPathChange: (nextPath: string) => void;
        onRefresh: (fallback: () => void) => void;
        openPopup: (url: string) => void;
        overlaysConnection: ConnectionStatus;
        perspective: PresentationPerspective;
        presentationRef:
            | ActorRef<Snapshot<unknown>, EventObject, EventObject>
            | ActorRef<
                MachineSnapshot<
                    MachineContext,
                    EventObject,
                    Record<string, AnyActorRef>,
                    StateValue,
                    string,
                    unknown,
                    MetaObject,
                    StateSchema,
                >,
                EventObject,
                EventObject,
            >
            | ActorRef<
                PromiseSnapshot<unknown, unknown>,
                { [k: string]: unknown },
                EventObject,
            >;
        previewUrl?: string;
        previewUrlRef:
            | ActorRef<Snapshot<unknown>, EventObject, EventObject>
            | ActorRef<
                MachineSnapshot<
                    MachineContext,
                    EventObject,
                    Record<string, AnyActorRef>,
                    StateValue,
                    string,
                    unknown,
                    MetaObject,
                    StateSchema,
                >,
                EventObject,
                EventObject,
            >
            | ActorRef<
                PromiseSnapshot<unknown, unknown>,
                { [k: string]: unknown },
                EventObject,
            >;
        setViewport: (mode: "desktop" | "mobile") => void;
        targetOrigin: string;
        toggleNavigator?: () => void;
        toggleOverlay: () => void;
        vercelProtectionBypass: string;
        viewport: PresentationViewport;
    }

    Hierarchy (View Summary)

    Index

    Properties

    canSharePreviewAccess: boolean
    canToggleSharePreviewAccess: boolean
    canUseSharedPreviewAccess: boolean
    header?: HeaderOptions
    initialUrl: URL
    loadersConnection: ConnectionStatus
    navigatorEnabled: boolean
    onPathChange: (nextPath: string) => void
    onRefresh: (fallback: () => void) => void
    openPopup: (url: string) => void
    overlaysConnection: ConnectionStatus
    presentationRef:
        | ActorRef<Snapshot<unknown>, EventObject, EventObject>
        | ActorRef<
            MachineSnapshot<
                MachineContext,
                EventObject,
                Record<string, AnyActorRef>,
                StateValue,
                string,
                unknown,
                MetaObject,
                StateSchema,
            >,
            EventObject,
            EventObject,
        >
        | ActorRef<
            PromiseSnapshot<unknown, unknown>,
            { [k: string]: unknown },
            EventObject,
        >
    previewUrl?: string
    previewUrlRef:
        | ActorRef<Snapshot<unknown>, EventObject, EventObject>
        | ActorRef<
            MachineSnapshot<
                MachineContext,
                EventObject,
                Record<string, AnyActorRef>,
                StateValue,
                string,
                unknown,
                MetaObject,
                StateSchema,
            >,
            EventObject,
            EventObject,
        >
        | ActorRef<
            PromiseSnapshot<unknown, unknown>,
            { [k: string]: unknown },
            EventObject,
        >
    setViewport: (mode: "desktop" | "mobile") => void
    targetOrigin: string
    toggleNavigator?: () => void
    toggleOverlay: () => void
    vercelProtectionBypass: string