react-warp
v2.0.1
Published
A simple react 16+ portal system
Downloads
10
Readme
React-Warp 🌀
A dead simple component to handle rendering portals.
Simply pass in your children and provide an isOpen
prop:
<div>
<Portal isOpen={this.state.showPortal}>
<h1>The 🍰 is a lie!</h1>
</Portal>
</div>
Under the Hood:
This uses React 16's createPortal
, it also has an additional hook to allow implementers to provider their own factory function for determining where to mount the portal.
API:
<Portal>
props:isOpen
: boolean determines if the portal is rendering the children or nullprovideMountPoint
: function a function to return the portal mount point, defaults to creating a div and appending it to the bottom of the body