Skip to content

Add optional node container target to Portal #756

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

Merged
merged 5 commits into from
Sep 4, 2021
Merged

Add optional node container target to Portal #756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
181c734
Add nodeContainer to Portal to be able to target a specific DOM node
Warsaken Mar 2, 2021
733186e
Add Portal prop 'type' to website documentation
Warsaken Mar 2, 2021
3854602
Add Portal prop 'nodeContainer' to website documentation
Warsaken Mar 2, 2021
5a44e66
Changed prop name from 'nodeContainer' to 'container' and minor corre…
Warsaken Apr 1, 2021
1ef0803
Change portal container type to a ref
Warsaken Aug 15, 2021
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
19 changes: 15 additions & 4 deletions packages/portal/src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@ import { createPortal } from "react-dom";
*
* @see Docs https://reach.tech/portal#portal
*/
const Portal: React.FC<PortalProps> = ({ children, type = "reach-portal" }) => {
const Portal: React.FC<PortalProps> = ({
children,
type = "reach-portal",
containerRef,
}) => {
let mountNode = React.useRef<HTMLDivElement | null>(null);
let portalNode = React.useRef<HTMLElement | null>(null);
let forceUpdate = useForceUpdate();
Expand All @@ -32,11 +36,12 @@ const Portal: React.FC<PortalProps> = ({ children, type = "reach-portal" }) => {
// In that case, it's important to append to the correct document element.
const ownerDocument = mountNode.current!.ownerDocument;
portalNode.current = ownerDocument?.createElement(type)!;
ownerDocument!.body.appendChild(portalNode.current);
const body = containerRef?.current || ownerDocument.body;
body.appendChild(portalNode.current);
forceUpdate();
return () => {
if (portalNode.current && portalNode.current.ownerDocument) {
portalNode.current.ownerDocument.body.removeChild(portalNode.current);
if (portalNode.current && body) {
body.removeChild(portalNode.current);
}
};
}, [type, forceUpdate]);
Expand Down Expand Up @@ -64,6 +69,12 @@ type PortalProps = {
* @see Docs https://reach.tech/portal#portal-type
*/
type?: string;
/**
* Optional container ref to render the portal in.
*
* @see Docs https://reach.tech/portal#portal-containerRef
*/
containerRef?: React.RefObject<any>;
};

if (__DEV__) {
Expand Down
14 changes: 11 additions & 3 deletions website/src/pages/portal.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,11 @@ Renders content inside of a portal at the end of the DOM tree.

#### Portal Props

| Prop | Type | Required |
| ----------------------- | ---- | -------- |
| [`children`](#children) | node | true |
| Prop | Type | Required |
| ------------------------------- | ------ | -------- |
| [`children`](#children) | node | true |
| [`type`](#type) | string | false |
| [`containerRef`](#containerRef) | ref | false |

##### Portal children

Expand All @@ -83,3 +85,9 @@ Any content you want to render inside of the portal.
_Type_: `string` default: `reach-portal`

The DOM element type to render.

##### Portal containerRef

_containerRef_: `ref` default: `document.body`

Ref to the container in where to render the portal. If not set the portal will be appended to the body of the document.