Portal is used in other components such as Popover to render content to places like the HTML <body> tag, avoiding style leakage and parent layout contexts. Only accepts a single top-level child; naked text, etc will be wrapped in a <div>.

Props

Note: only top-level props are in the README, for the full list check out the website.

Required Props

There are no required props.

Optional Props

Name Type Default Value Description

children

Name	Type	Default Value	Description
children	`any renderable`	`null`	any normal React child, but must be singular; multiple sibling children must have a common wrapper, such as a "layout" ` ` ✅ OK: `<Portal> foo </Portal> <Portal> <div>foo</div> </Portal> <Portal> <div> <div>foo</div> <div>bar</div> </div> </Portal>` ⛔️ Not OK: <Portal> <div>foo</div> <div>bar</div> </Portal> ```</td> </tr> <tr> <td>destination</td> <td><pre><code>HTMLElement</code></pre></td> <td><pre><code class="language-js">document.body</code></pre></td> <td>the location to append the generated portal and child elements</td> </tr> <tr> <td>portalId</td> <td><pre><code>string</code></pre></td> <td><pre><code class="language-js">null</code></pre></td> <td>the ID used to link the portal origin to the destination; added to generated `<div>` appended to the destination HTML node</td> </tr> </table>

any renderable

null

any normal React child, but must be singular; multiple sibling children must have a common wrapper, such as a "layout" `

✅ OK:

<Portal>
  foo
</Portal>

<Portal>
  <div>foo</div>
</Portal>

<Portal>
  <div>
      <div>foo</div>
      <div>bar</div>
  </div>
</Portal>

⛔️ Not OK:

<Portal>
  <div>foo</div>
  <div>bar</div>
</Portal>
```</td>
</tr>

<tr>
<td>destination</td>
<td><pre><code>HTMLElement</code></pre></td>
<td><pre><code class="language-js">document.body</code></pre></td>
<td>the location to append the generated portal and child elements</td>
</tr>

<tr>
<td>portalId</td>
<td><pre><code>string</code></pre></td>
<td><pre><code class="language-js">null</code></pre></td>
<td>the ID used to link the portal origin to the destination; added to generated `<div>` appended to the destination HTML node</td>
</tr>

</table>

Keywords

FAQs

What is boundless-portal?

Is boundless-portal popular?

Is boundless-portal well maintained?

Package last updated on 25 Jan 2017

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.

Install

boundless-portal

Portal

Props

Required Props

Optional Props

Keywords

Related posts

Supply Chain Attack on Rspack npm Packages Injects Cryptojacking Malware

Skuld Infostealer Returns to npm with Fake Windows Utilities and Malicious Solara Development Packages