Skip to content
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

fix(react): updates Portal to have backward compatibility #2155

Merged
merged 1 commit into from
Feb 10, 2024
Merged

fix(react): updates Portal to have backward compatibility #2155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
103 changes: 103 additions & 0 deletions packages/frameworks/react/src/portal.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
import { render, screen } from '@testing-library/react'
import { useRef } from 'react'
import { Portal } from './portal'

const PortalWithContainerTest = (props: { disabled?: boolean }) => {
const container = useRef<HTMLDivElement>(null)
return (
<div>
<Portal container={container} disabled={props.disabled}>
<p>Anything must be visible</p>
</Portal>
<div data-testid="container" ref={container}></div>
</div>
)
}

describe('Portal', () => {
it('should render portal without element children', () => {
render(<Portal>Anything must be visible</Portal>)
expect(screen.getByText('Anything must be visible')).toBeVisible()
})

it('should render portal with element children', () => {
render(
<Portal>
<p>Anything must be visible</p>
</Portal>,
)
expect(screen.getByText('Anything must be visible')).toBeVisible()
})

it('should render portal with multiple element children', () => {
render(
<Portal>
<p>Anything must be visible</p>
<p>Another visible item</p>
</Portal>,
)
expect(screen.getByText('Anything must be visible')).toBeVisible()
expect(screen.getByText('Another visible item')).toBeVisible()
})

it('should render portal children next to the body', () => {
const view = render(
<div>
<Portal>
<p>Anything must be visible</p>
</Portal>
</div>,
)

expect(view.baseElement).toMatchInlineSnapshot(`
<body>
<div>
<div />
</div>
<p>
Anything must be visible
</p>
</body>
`)
})

it('should not render portal children next to the body if marked as `disabled`', () => {
const view = render(
<div>
<Portal disabled>
<p>Anything must be visible</p>
</Portal>
</div>,
)

expect(view.baseElement).toMatchInlineSnapshot(`
<body>
<div>
<div>
<p>
Anything must be visible
</p>
</div>
</div>
</body>
`)
})

it('should render portal children inside a custom element', () => {
render(<PortalWithContainerTest />)

const container = screen.getByTestId('container')
expect(container).toBeInTheDocument()
expect(container).not.toBeEmptyDOMElement()
expect(screen.getByText('Anything must be visible')).toBeVisible()
})

it('should not render portal children inside a custom element if marked as `disabled`', () => {
render(<PortalWithContainerTest disabled />)

const container = screen.getByTestId('container')
expect(container).toBeInTheDocument()
expect(container).toBeEmptyDOMElement()
expect(screen.getByText('Anything must be visible')).toBeVisible()
})
})
16 changes: 4 additions & 12 deletions packages/frameworks/react/src/portal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
import {
Children,
type PropsWithChildren,
type ReactNode,
type ReactPortal,
type RefObject,
} from 'react'
import { Children, type PropsWithChildren, type RefObject } from 'react'
import { createPortal } from 'react-dom'
import { useEnvironmentContext } from './environment'
import { useIsServer } from './use-is-server'
Expand All @@ -14,17 +8,15 @@ export interface PortalProps {
container?: RefObject<HTMLElement>
}

export const Portal = (
props: PropsWithChildren<PortalProps>,
): ReactPortal[] | ReactNode | null | undefined => {
export const Portal = (props: PropsWithChildren<PortalProps>) => {
const { children, container, disabled } = props
const isServer = useIsServer()
const getRootNode = useEnvironmentContext()

if (isServer || disabled) return children
if (isServer || disabled) return <>{children}</>

const doc = getRootNode?.().ownerDocument ?? document
const mountNode = container?.current ?? doc.body

return Children.map(children, (child) => createPortal(child, mountNode))
return <>{Children.map(children, (child) => createPortal(child, mountNode))}</>
}
Loading