Skip to content

feat(render): add wrapper component option #303

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.

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
Feb 19, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
feat(render): add wrapper component option
  • Loading branch information
alexkrolick committed Feb 16, 2019
commit 795ce09a70ba0045cc9851b38dd1ead81196d17d
21 changes: 21 additions & 0 deletions src/__tests__/render.js
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,24 @@ it('supports fragments', () => {
cleanup()
expect(document.body.innerHTML).toBe('')
})

test('renders options.wrapper around node', () => {
const WrapperComponent = ({children}) => (
<div data-testid="wrapper">{children}</div>
)

const {container, getByTestId} = render(<div data-testid="inner" />, {
wrapper: WrapperComponent,
})

expect(getByTestId('wrapper')).toBeInTheDocument()
expect(container.firstChild).toMatchInlineSnapshot(`
<div
data-testid="wrapper"
>
<div
data-testid="inner"
/>
</div>
`)
})
44 changes: 25 additions & 19 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,13 @@ const mountedContainers = new Set()

function render(
ui,
{container, baseElement = container, queries, hydrate = false} = {},
{
container,
baseElement = container,
queries,
hydrate = false,
wrapper: WrapperComponent,
} = {},
) {
if (!container) {
// default to document.body instead of documentElement to avoid output of potentially-large
Expand All @@ -25,13 +31,18 @@ function render(
// they're passing us a custom container or not.
mountedContainers.add(container)

const wrapUiIfNeeded = innerElement =>
WrapperComponent
? React.createElement(WrapperComponent, null, innerElement)
: innerElement

if (hydrate) {
act(() => {
ReactDOM.hydrate(ui, container)
ReactDOM.hydrate(wrapUiIfNeeded(ui), container)
})
} else {
act(() => {
ReactDOM.render(ui, container)
ReactDOM.render(wrapUiIfNeeded(ui), container)
})
}
return {
Expand All @@ -41,7 +52,7 @@ function render(
debug: (el = baseElement) => console.log(prettyDOM(el)),
unmount: () => ReactDOM.unmountComponentAtNode(container),
rerender: rerenderUi => {
render(rerenderUi, {container, baseElement})
render(wrapUiIfNeeded(rerenderUi), {container, baseElement})
// Intentionally do not return anything to avoid unnecessarily complicating the API.
// folks can use all the same utilities we return in the first place that are bound to the container
},
Expand Down Expand Up @@ -70,25 +81,20 @@ function testHook(callback, options = {}) {
const result = {
current: null,
}
const toRender = () => {
const hookRender = (
<TestHook callback={callback}>
{res => {
result.current = res
}}
</TestHook>
)
if (options.wrapper) {
return React.createElement(options.wrapper, null, hookRender)
}
return hookRender
}
const {unmount, rerender: rerenderComponent} = render(toRender())
const toRender = () => (
<TestHook callback={callback}>
{res => {
result.current = res
}}
</TestHook>
)

const {unmount, rerender: rerenderComponent} = render(toRender(), options)
return {
result,
unmount,
rerender: () => {
rerenderComponent(toRender())
rerenderComponent(toRender(), options)
},
}
}
Expand Down