Skip to content

react-component/portal

Repository files navigation

rc-portal

React 18 supported Portal Component.

NPM version dumi build status Codecov npm download

Development

npm install
npm start
open http://localhost:8000

Feature

  • React life cycle support portal component

Install

rc-portal

Usage

import Portal from 'rc-portal';

const Demo = () => {
  return <Portal open>Hello World</Portal>;
};

export default Demo;

🔥 API

We use typescript to create the Type definition. You can view directly in IDE. But you can still check the type definition here.

Portal

Prop Description Type Default
getContainer Customize portal container element Element | () => Element document.body
open Show the portal boolean false
autoLock Lock screen scroll when open boolean false