Skip to content
A minimalist portal for react
JavaScript
Branch: master
Clone or download
Latest commit 6b7c308 May 24, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
test
.babelrc
.eslintrc
.gitignore
.npmignore
.publishrc
.travis.yml
LICENSE
README.md
package.json
yarn.lock

README.md

react-minimalist-portal

A minimalist portal for react. Create a new React tree in document.body to create modal etc .. This package is compatible with react 15 and 16.

npm version npm Build Status Coverage Status

Usage

import React from 'react';
import Portal from 'react-minimalist-portal';

export default class App extends React.Component {
  render() {
    return (
      <Portal>
        <p>I am in document body.</p>
      </Portal>
    );
  }
}

// If you want to render the portal inside your own container
const container = document.getElementById('my-custom-container-id');

export default class App extends React.Component {
  render() {
    return (
      <Portal container={container}>
        <p>I am in my-custom-container-id.</p>
      </Portal>
    );
  }
}

Props

  • container - optional - You can specify a container prop which should be of Element type. The portal will be rendered inside that element. The default behavior will create a div node and render it at the at the end of document.body.
You can’t perform that action at this time.