Sanity Library Reference Docs
Preparing search index...
sanity
index
useCanvasCompanionDoc
Function useCanvasCompanionDoc
Given a document id, returns whether it is linked to canvas and the companion doc if it exists.
useCanvasCompanionDoc
(
documentId
:
string
,
)
:
{
companionDoc
:
CompanionDoc
;
isLinked
:
boolean
;
loading
:
boolean
}
Beta
Parameters
documentId
:
string
Returns
{
companionDoc
:
CompanionDoc
;
isLinked
:
boolean
;
loading
:
boolean
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Sanity Library Reference Docs
Loading...
Given a document id, returns whether it is linked to canvas and the companion doc if it exists.