Sanity Library Reference Docs
    Preparing search index...

    Interface useDocumentPreviewOptions

    interface useDocumentPreviewOptions {
        dataset?: string;
        documentId: string;
        documentType: string;
        liveEdit?: boolean;
        perspective?: ReleasePerspective | ClientPerspective;
        projectId?: string;
        ref?: RefObject<unknown>;
        source?: DocumentSource;
        sourceName?: string;
    }

    Hierarchy

    Index

    Properties

    dataset? documentId documentType liveEdit? perspective? projectId? ref? source? sourceName?

    Properties

    dataset?: string
    documentId: string
    documentType: string
    liveEdit?: boolean

    Indicates whether this document uses liveEdit mode. When true, the document does not use the draft/published model and edits are applied directly to the document.

    https://www.sanity.io/docs/content-lake/drafts#ca0663a8f002

    perspective?: ReleasePerspective | ClientPerspective
    projectId?: string
    ref?: RefObject<unknown>

    Optional ref object to track visibility. When provided, preview resolution only occurs when the referenced element is visible in the viewport.

    source?: DocumentSource

    Explicit source object to use for this operation.

    sourceName?: string

    Optional name of a source to resolve from context. If provided, will be resolved to a DocumentSource via SourcesContext.

    Settings

    Member Visibility

    On This Page

    Properties