Remove SearchContextProvider from Root component

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>
backstage · Feb 10, 2022 · e725bb8 · e725bb8
1 parent 52d2d36
commit e725bb8
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 7 deletions.
diff --git a/.changeset/bright-games-eat.md b/.changeset/bright-games-eat.md
@@ -0,0 +1,24 @@
+---
+'@backstage/create-app': patch
+---
+
+Remove SearchContextProvider from `<Root />`
+
+The `SidebarSearchModal` exported from `plugin-search` internally renders `SearchContextProvider`, so it can be removed from `Root.tsx`:
+
+```diff
+-import {
+-  SidebarSearchModal,
+-  SearchContextProvider,
+-} from '@backstage/plugin-search';
++import { SidebarSearchModal } from '@backstage/plugin-search';
+
+... omitted ...
+
+       <SidebarGroup label="Search" icon={<SearchIcon />} to="/search">
+-        <SearchContextProvider>
+-          <SidebarSearchModal />
+-        </SearchContextProvider>
++        <SidebarSearchModal />
+       </SidebarGroup>
+```
diff --git a/packages/create-app/templates/default-app/packages/app/src/components/Root/Root.tsx b/packages/create-app/templates/default-app/packages/app/src/components/Root/Root.tsx
@@ -28,10 +28,7 @@ import {
   Settings as SidebarSettings,
   UserSettingsSignInAvatar,
 } from '@backstage/plugin-user-settings';
-import {
-  SidebarSearchModal,
-  SearchContextProvider,
-} from '@backstage/plugin-search';
+import { SidebarSearchModal } from '@backstage/plugin-search';
 import {
   Sidebar,
   sidebarConfig,
@@ -84,9 +81,7 @@ export const Root = ({ children }: PropsWithChildren<{}>) => (
     <Sidebar>
       <SidebarLogo />
       <SidebarGroup label="Search" icon={<SearchIcon />} to="/search">
-        <SearchContextProvider>
-          <SidebarSearchModal />
-        </SearchContextProvider>{' '}
+        <SidebarSearchModal />
       </SidebarGroup>
       <SidebarDivider />
       <SidebarGroup label="Menu" icon={<MenuIcon />}>