Skip to content

Portal: Add PortalProvider for default container context #3812

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rxliuli wants to merge 2 commits into
base: main
Choose a base branch
from
+33 −3
Open

Portal: Add PortalProvider for default container context #3812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a66b0e5
Portal: Add PortalProvider for default container context
rxliuli Feb 12, 2026
584495f
Add changeset for PortalProvider
rxliuli Feb 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/add-portal-provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@radix-ui/react-portal': minor
---

Added `PortalProvider` to set a default portal container via context, useful for Shadow DOM scenarios
3 changes: 2 additions & 1 deletion packages/react/portal/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
'use client';
export {
Portal,
PortalProvider,
//
Root,
} from './portal';
export type { PortalProps } from './portal';
export type { PortalProps, PortalProviderProps } from './portal';
28 changes: 26 additions & 2 deletions packages/react/portal/src/portal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,28 @@ import ReactDOM from 'react-dom';
import { Primitive } from '@radix-ui/react-primitive';
import { useLayoutEffect } from '@radix-ui/react-use-layout-effect';

/* -------------------------------------------------------------------------------------------------
* PortalProvider
* -----------------------------------------------------------------------------------------------*/

const PortalContext = React.createContext<Element | DocumentFragment | null>(null);
PortalContext.displayName = 'PortalContext';

interface PortalProviderProps {
children: React.ReactNode;
/**
* The default container element for portaled content.
* @defaultValue document.body
*/
container: Element | DocumentFragment;
}

const PortalProvider: React.FC<PortalProviderProps> = ({ container, children }) => {
return <PortalContext.Provider value={container}>{children}</PortalContext.Provider>;
};

PortalProvider.displayName = 'PortalProvider';

/* -------------------------------------------------------------------------------------------------
* Portal
* -----------------------------------------------------------------------------------------------*/
Expand All @@ -20,9 +42,10 @@ interface PortalProps extends PrimitiveDivProps {

const Portal = React.forwardRef<PortalElement, PortalProps>((props, forwardedRef) => {
const { container: containerProp, ...portalProps } = props;
const contextContainer = React.useContext(PortalContext);
const [mounted, setMounted] = React.useState(false);
useLayoutEffect(() => setMounted(true), []);
const container = containerProp || (mounted && globalThis?.document?.body);
const container = containerProp || contextContainer || (mounted && globalThis?.document?.body);
return container
? ReactDOM.createPortal(<Primitive.div {...portalProps} ref={forwardedRef} />, container)
: null;
Expand All @@ -36,7 +59,8 @@ const Root = Portal;

export {
Portal,
PortalProvider,
//
Root,
};
export type { PortalProps };
export type { PortalProps, PortalProviderProps };