# portals-component

> this is library for portals components for React.js

Latest version **0.0.5** (published 2018-07-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install portals-component
pnpm add portals-component
yarn add portals-component
bun add portals-component
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2018-07-13 |
| First published | 2018-04-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | takahiro-saeki |
| Maintainers | takahiro-saeki |

## Links

- npm: https://www.npmjs.com/package/portals-component
- Repository: https://github.com/takahiro-saeki/portals-component
- Homepage: https://github.com/takahiro-saeki/portals-component#readme
- Issues: https://github.com/takahiro-saeki/portals-component/issues
- npm.io page: https://npm.io/package/portals-component

## Dependencies (1)

- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.26.0

## Recent versions

- 0.0.5 (latest) — 2018-07-13
- 0.0.1 (beta) — 2018-04-23
- 0.0.4 — 2018-07-12
- 0.0.3 — 2018-04-24
- 0.0.2 — 2018-04-24

## README

# portals-component
[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
[![Maintainability](https://api.codeclimate.com/v1/badges/f93bca589d98fc4ad589/maintainability)](https://codeclimate.com/github/takahiro-saeki/portals-component/maintainability)
[![npm version](https://badge.fury.io/js/portals-component.svg)](https://badge.fury.io/js/portals-component)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/232dfbd62e29478f9cb05f540d81c46a)](https://www.codacy.com/app/takahiro-saeki/portals-component?utm_source=github.com&utm_medium=referral&utm_content=takahiro-saeki/portals-component&utm_campaign=Badge_Grade)  
this is utility for portals api for React.js.

## Problem
Have you ever come across problem which to use React.js partially?
If so, you might have stribed to use React.js because you might have to `ReactDOM.render()` multiple times.
but if you don't twist your idea, you can't pass state data to other area of `ReactDOM.render()` .
If it's over middle apps, that's would be harder.

## Resolution
parhaps, you might have read this [official document](https://reactjs.org/docs/portals.html).
So, resolution is to use portals API!

This library is using portals API internally. if you use portals-component, this means you use portals api internal of this library.

## Why not just use it?
that's because I wanted to assemble as a utility. I was faced situations which I have to use portals in production. First, I used `ReactDOM.render` multiple times, but I realized I can't pass state to other `ReactDOM.render()` area. I didn't care of it for a long time like 2 or 3 month. but one day, I was faced problem which I had to pass state to `ReactDOM.render` area to different `ReactDOM.render` .

At the same time, Facebook published `portals` App, so I decided to use it. after that I came up with idea of this library of base.

## Props
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| el | string | '' | dom element which is rendered. |
| children | node | null | react element, you can use like `this.props.children` . |
| dom | string | div | wrapper dom element. when you render DOM through using portals api, you have to specify dom element. |

## Example
Let's say, you have a html file like below.

```html
<html>
<head>
  <title>portals component</title>
</head>
<body>
  <div id="app"></div>
  <div id="portals-test"></div>
  <script src="./index.js"></script>
</body>
</html>
```

then, you can use `portals-component` like below.
```jsx
import React from 'react';
import { render } from 'react-dom';
import PortalsComponent from '../lib';

const App = () => (
  <div>
    <PortalsComponent el="#portals-test">
      <div>app</div>
    </PortalsComponent>
    <div>different</div>
  </div>
)

render(<App />, document.getElementById('app'))
```

then, you can check dom which is rendered by using inspector like Google chrome.
`id app` will be rendered like below.

```html
<div>
  <div>different</div>
</div>
```

and inside of `id portals-test` is like below

```html
<div>
  <div>app</div>
</div>
```

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