feat(titles): Adds controlsDocumentTitle property to Tool

sanity-io · Sep 5, 2023 · 5242d30 · 5242d30
1 parent 917c34e
commit 5242d30
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/packages/sanity/src/core/config/types.ts b/packages/sanity/src/core/config/types.ts
@@ -141,6 +141,11 @@ export interface Tool<Options = any> {
    */
   title: string
 
+  /**
+   * Determines whether the tool will control the document title.
+   */
+  controlsDocumentTitle?: boolean
+
   /**
    * Gets the state for the given intent.
    *

diff --git a/packages/sanity/src/core/studio/StudioLayout.tsx b/packages/sanity/src/core/studio/StudioLayout.tsx
@@ -89,14 +89,14 @@ export function StudioLayout() {
 
     return mainTitle
   }, [activeToolName, name, title])
+  const toolControlsDocumentTitle = !!activeTool?.controlsDocumentTitle
 
   useEffect(() => {
-    if (activeToolName === 'content') {
-      // Will be handled by sanity/src/desk/components/deskTool/DeskTitle.tsx
+    if (toolControlsDocumentTitle) {
       return
     }
     document.title = documentTitle
-  }, [documentTitle, activeToolName])
+  }, [documentTitle, toolControlsDocumentTitle])
 
   const handleSearchFullscreenOpenChange = useCallback((open: boolean) => {
     setSearchFullscreenOpen(open)

diff --git a/packages/sanity/src/desk/deskTool.ts b/packages/sanity/src/desk/deskTool.ts
@@ -107,6 +107,8 @@ export const deskTool = definePlugin<DeskToolOptions | void>((options) => ({
             (intent === 'create' && params.template),
         )
       },
+      // Controlled by sanity/src/desk/components/deskTool/DeskTitle.tsx
+      controlsDocumentTitle: true,
       getIntentState,
       options,
       router,