Sanity Library Reference Docs
    Preparing search index...

    Function useCanvasCompanionDoc

    Given a document id, returns whether it is linked to canvas and the companion doc if it exists.

    • Beta

      Parameters

      • documentId: string

      Returns {
          companionDoc: CompanionDoc;
          isLinked: boolean;
          isLockedByCanvas: boolean;
          loading: boolean;
      }