# react-portalizer

> Simple React Portal component with out-of-box features.

Latest version **1.0.2** (published 2017-10-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-portalizer
pnpm add react-portalizer
yarn add react-portalizer
bun add react-portalizer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2017-10-13 |
| First published | 2017-10-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | meyve |
| Maintainers | meyve |
| Keywords | react, react-portalizer, react-portal, portal |

## Links

- npm: https://www.npmjs.com/package/react-portalizer
- Repository: https://github.com/meyve/react-portalizer
- Homepage: https://github.com/meyve/react-portalizer#readme
- Issues: http://github.com/meyve/react-portalizer/issues
- npm.io page: https://npm.io/package/react-portalizer

## Dependencies (3)

- [react](https://npm.io/package/react.md) ^16.0.0
- [react-dom](https://npm.io/package/react-dom.md) ^16.0.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.5.10

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2017-10-13
- 1.0.1 — 2017-10-12
- 1.0.0 — 2017-10-12

## README

# Getting Started
## Installation

```
$ npm install --save react-portalizer
```

## Usage

You can handle Portal's state by your parent's state.
```javascript
import React from 'react';
import { Portal } from 'react-portalizer';

class MyComponent extends React.Component {
    constructor(props){
        super(props);
        
        this.state = {
            isOpened: false
        }
    }
	
	render() {
        return (
            <div>
                <Portal
                    isOpened={this.state.isOpened}
                >
                /* Your children should be placed here */   
                </Portal>
            </div>
            )
    }
}
```


Or you can make Portal take care of itself by passing *openPortalByClickOnElement* prop.
```javascript
import React from 'react';
import { Portal } from 'react-portalizer';

class MyComponent extends React.Component {
    constructor(props){
        super(props);
        
        this.state = {
            isOpened: false
        }
    }
	
	render() {
        return (
            <div>
                <Portal
                    openPortalByClickOnElement={<button>Open portal, please</button>}
                >
                /* Your children should be placed here */   
                </Portal>
            </div>
            )
    }
}
```


## Available options
<br>

To use Poral you need pass to it one of two props - either **isOpened** or **openPortalByClickOnElement**.

* **isOpened:** *(Boolean)* - should Portal be opened or not.
* **openPortalByClickOnElement:** *(Node)* - element that should toggle Portal's appearence
* **closeOnEsc** *(Boolean)* - close Portal when ESC is pressed
* **closeOnOutsideClick** *(Boolean)* - close Portal when click occured outside of Portal's body
* **onOpen** *(Function)* - function to be called ***after*** Portal is opened
* **beforeOpen** *(Function)* - function to be called ***before*** Portal is opened 
* **onClose** *(Function)* - function to be called ***after*** Portal is closed
* **beforeClose** *(Function)* - function to be called ***before*** Portal is closed
<br>
<br>
<br>

---
_Source: https://npm.io/package/react-portalizer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._