refactor: added shouldAddRootHost to provider component

gorhom · Jan 6, 2022 · 9d0a5db · 9d0a5db
1 parent d84711d
commit 9d0a5db
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/src/components/portalProvider/PortalProvider.tsx b/src/components/portalProvider/PortalProvider.tsx
@@ -4,13 +4,16 @@ import { PortalDispatchContext, PortalStateContext } from '../../contexts';
 import { reducer, INITIAL_STATE } from '../../state';
 import type { PortalProviderProps } from './types';
 
-const PortalProviderComponent = ({ children }: PortalProviderProps) => {
+const PortalProviderComponent = ({
+  shouldAddRootHost = true,
+  children,
+}: PortalProviderProps) => {
   const [state, dispatch] = useReducer(reducer, INITIAL_STATE);
   return (
     <PortalDispatchContext.Provider value={dispatch}>
       <PortalStateContext.Provider value={state}>
         {children}
-        <PortalHost name="root" />
+        {shouldAddRootHost && <PortalHost name="root" />}
       </PortalStateContext.Provider>
     </PortalDispatchContext.Provider>
   );

diff --git a/src/components/portalProvider/types.d.ts b/src/components/portalProvider/types.d.ts
@@ -1,5 +1,12 @@
 import type { ReactNode } from 'react';
 
 export interface PortalProviderProps {
+  /**
+   * Defines whether to add a default root host or not.
+   *
+   * @default true
+   * @type boolean
+   */
+  shouldAddRootHost?: boolean;
   children: ReactNode | ReactNode[];
 }