react-portalize
Advanced tools
A component for injecting elements into React Portals via DOM selectors. You may optionally choose to render your portals on the server side as well :)
A component for injecting elements into React Portals via DOM selectors. You may optionally choose to render your portals on the server side as well :)
yarn add react-portalize or npm i react-portalize
import Portalize from 'react-portalize'
// renders 'Hello' into <div id='portals'/>
<Portalize container='#portals'>
Hello
</Portalize>
// renders 'Hello' into all instances of <div class='portals'/>
<Portalize container='.portals'>
Hello
</Portalize>
// renders 'Hello' into all instances of <section/>
<Portalize container='section'>
Hello
</Portalize>
// renders 'Hello' into all instances of <div data-portalize="why not"/>
<Portalize container='div[data-portalize="why not"]'>
Hello
</Portalize>
Hello world
Hello world w/ Context
<Portalize
container={string}
children={React.Component}
providers={Array}
server={boolean}
/>
container <string>
#portalschildren <React.Component>
server <boolean>
server={false} flag. You don't need to worry about turning this
off if you aren't rendering on the server with renderPortalsToStringtrueproviders <Array[Object<{provider, value}>]>
<Provider value={}/> components wrapped
around them. The providers supplied in the array are reduced from the
right, so [a, b, c] renders as <a><b><c/></b></a>. You can check out
an example here.
<Portalize providers={[{provider: YourProvider, value: YourProviderValue}]}>
<YourConsumer>
{value => JSON.stringify(value)}
</YourConsumer>
</Portalize>
renderPortalsToString(html <string>)<!DOCTYPE html> string here or
alternatively just the React root generated by
ReactDOMServer.renderToString().import {renderPortalsToString} from 'react-portalize/server'
function serverRenderer req, res, next() {
const page = renderPortalsToString(
ReactDOMServer.renderToString(<App/>)
)
res.set('Content-Type', 'text/html').send(`
<!DOCTYPE html>
<html lang="en">
<head>
<title>Hello world app</title>
</head>
<body>
<div id="⚛️">${page}</div>
</body>
</html>
`)
}
import {renderPortalsToString} from 'react-portalize/server'
function serverRenderer (req, res, next) {
const page = ReactDOMServer.renderToString(<App/>)
res.set('Content-Type', 'text/html').send(
renderPortalsToString(`
<!DOCTYPE html>
<html lang="en">
<head>
<title>Hello world app</title>
</head>
<body>
<div id="⚛️">${page}</div>
</body>
</html>
`)
)
}
You will receive a warning message in the console from ReactDOM.hydrate() in
"development" akin to Did not expect server HTML to contain the text node "Hello" in <div>..
This is because ReactDOM.hydrate() does not expect your portals to be rendered
into the App. You can safely ignore this warning.
renderPortalsToNodeStream()FAQs
```jsx harmony import Portalize from 'react-portalize'
The npm package react-portalize receives a total of 691 weekly downloads. As such, react-portalize popularity was classified as not popular.
We found that react-portalize demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.