Sanity Library Reference Docs
    Preparing search index...

    Function getDocumentIsInPerspective

    • Beta

      Parameters

      • documentId: string

        The document id, e.g. my-document-id or drafts.my-document-id or summer.my-document-id

      • perspective: string

        The current perspective, e.g. release.summer or undefined, it can be obtained from useRouter().stickyParams.perspective

      Returns boolean

      boolean - true if the document is in the current perspective. e.g:

      • document: summer.my-document-id, perspective: release.summer : true
      • document: my-document-id, perspective: release.summer : false
      • document: summer.my-document-idperspective: release.winter : false
      • document: summer.my-document-id, perspective: undefined : false
      • document: my-document-id, perspective: undefined : true
      • document: drafts.my-document-id, perspective: undefined : true

    Settings

    Member Visibility