fix: delays rendering the Start in Create banner until document is ready

sanity-io · Dec 12, 2024 · 0f2cf84 · 0f2cf84
1 parent 2982082
commit 0f2cf84
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/packages/sanity/src/core/create/components/StartInCreateBanner.tsx b/packages/sanity/src/core/create/components/StartInCreateBanner.tsx
@@ -55,7 +55,8 @@ export function StartInCreateBanner(props: StartInCreateBannerProps) {
 function StartInCreateBannerInner(props: StartInCreateBannerProps & {appIdCache: AppIdCache}) {
   const {studioApp} = useStudioAppIdStore(props.appIdCache)
 
-  if (!studioApp) {
+  // we check documentReady here and not in the top wrapper, to allow the cache code to run while the document is loading
+  if (!studioApp || !props.documentReady) {
     return null
   }
   return <StartInCreateBannerStudioApp {...props} studioApp={studioApp} />

diff --git a/packages/sanity/src/core/create/types.ts b/packages/sanity/src/core/create/types.ts
@@ -38,5 +38,6 @@ export interface StartInCreateBannerProps {
   documentType: ObjectSchemaType
   document: SanityDocumentLike
   isInitialValueLoading: boolean
+  documentReady: boolean
   panelPortalElementId: string
 }
diff --git a/packages/sanity/src/structure/panes/document/document-layout/DocumentLayout.tsx b/packages/sanity/src/structure/panes/document/document-layout/DocumentLayout.tsx
@@ -82,6 +82,7 @@ export function DocumentLayout() {
     schemaType,
     value,
     isInitialValueLoading,
+    ready,
   } = useDocumentPane()
   const {params: paneParams} = usePaneRouter()
   const {features} = useStructureTool()
@@ -259,6 +260,7 @@ export function DocumentLayout() {
                     document={value}
                     documentId={documentId}
                     documentType={schemaType}
+                    documentReady={ready}
                     isInitialValueLoading={!!isInitialValueLoading}
                     panelPortalElementId={DOCUMENT_PANEL_PORTAL_ELEMENT}
                   />