# @chardskarth/react-gateway

> Render React DOM into a new context

Latest version **3.1.1** (published 2022-08-23) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @chardskarth/react-gateway
pnpm add @chardskarth/react-gateway
yarn add @chardskarth/react-gateway
bun add @chardskarth/react-gateway
```

## 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 | 3.1.1 |
| Published | 2022-08-23 |
| First published | 2020-02-20 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 26.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Richard Domingo |
| Maintainers | chardskarth |
| Keywords | react, gateway, portal, modal, dialog |

## Links

- npm: https://www.npmjs.com/package/@chardskarth/react-gateway
- Repository: https://github.com/chardskarth/react-gateway
- Homepage: https://github.com/chardskarth/react-gateway#readme
- Issues: https://github.com/chardskarth/react-gateway/issues
- npm.io page: https://npm.io/package/@chardskarth/react-gateway

## Dependencies (2)

- [prop-types](https://npm.io/package/prop-types.md) ^15.5.0
- [react-prop-types](https://npm.io/package/react-prop-types.md) ^0.4.0

## Recent versions

- 3.1.1 (latest) — 2022-08-23
- 3.0.3 — 2020-02-24
- 3.0.2 — 2020-02-24
- 3.0.1 — 2020-02-24
- 3.0.0 — 2020-02-20

## README

# React Gateway

Render React DOM into a new context (aka "Portal")

> This project is a forked update from https://github.com/cloudflare/react-gateway. Simplified test builds and updated with react hooks.

## Installation

```sh
$ npm install --save @chardskarth/react-gateway
```

## Example

```js
import React from 'react';
import {
  Gateway,
  GatewayDest,
  GatewayProvider
} from '@chardskarth/react-gateway';

export default class Application extends React.Component {
  render() {
    return (
      <GatewayProvider>
        <div>
          <h1>React Gateway Universal Example</h1>
          <div className="container">
            <Gateway into="one">
              <div className="item">Item 1</div>
            </Gateway>
            <Gateway into="two">
              <div className="item">Item 2</div>
            </Gateway>
            <div className="item">Item 3</div>
          </div>
          <GatewayDest name="one" component="section" className="hello"/>
          <GatewayDest name="two"/>
        </div>
      </GatewayProvider>
    );
  }
}
```

Will render as:

```js
<div>
  <h1>React Gateway Universal Example</h1>
  <div className="container">
    <noscript></noscript>
    <noscript></noscript>
    <div className="item">Item 3</div>
  </div>
  <section className="hello">
    <div className="item">Item 1</div>
  </section>
  <div>
    <div className="item">Item 2</div>
  </div>
</div>
```

## Usage

To get started with React Gateway, first wrap your application in the
`<GatewayProvider>`.

```diff
  import React from 'react';
+ import {
+   GatewayProvider
+ } from 'react-gateway';

  export default class Application extends React.Component {
    render() {
      return (
+       <GatewayProvider>
          <div>
            {this.props.children}
          </div>
+       </GatewayProvider>
      );
    }
  }
```

Then insert a `<GatewayDest>` whereever you want it to render and give it a
name.

```diff
  import React from 'react';
  import {
    GatewayProvider,
+   GatewayDest
  } from 'react-gateway';

  export default class Application extends React.Component {
    render() {
      return (
        <GatewayProvider>
          <div>
            {this.props.children}
+           <GatewayDest name="global"/>
          </div>
        </GatewayProvider>
      );
    }
  }
```
You could also add an `unmountOnEmpty` option to prevent a `GatewayDest` element from rendering if 
there are no `<Gateway into>` match for a `<GatewayDest name>`.

Then in any of your components (that get rendered inside of the
`<GatewayProvider>`) add a `<Gateway>`.

```diff
  import React from 'react';
+ import {Gateway} from 'react-gateway';

  export default class MyComponent extends React.Component {
    render() {
      return (
        <div>
+         <Gateway into="global">
+           Will render into the "global" gateway.
+         </Gateway>
        </div>
      );
    }
  }
```

If you want to customize the `<GatewayDest>` element, you can pass any props,
including `component` (which will allows you to specify a `tagName` or custom
component), and they will be passed to the created element.

```diff
  export default class Application extends React.Component {
    render() {
      return (
        <GatewayProvider>
          <div>
            {this.props.children}
-           <GatewayDest name="global"/>
+           <GatewayDest name="global" component="section" className="global-gateway"/>
          </div>
        </GatewayProvider>
      );
    }
  }
```

## GatewayDest props

| Prop Name | Description |
| -- | -- |
| `name` | name of this container. Renders all `Gateway` that have the matching `Gateway` `into` prop value. |
| `component` | React component that renders. Defaults to `div`.  |
| `unmountOnEmpty` | if true, the DOM container removes itself if there are no child `Gateway` to be rendered. |

## Gateway props
| Prop Name | Description |
| -- | -- |
| `into` | name of the `GatewayDest` to render itself into. |
| `sort` | Number. Defines its sorting order among its sibling `Gateway` |

## How it works

React Gateway works very differently than most React "portals" in order to work
in server-side rendered React applications.

It maintains an internal registry of "containers" and "children" which manages
where things should be rendered.

This registry is created by `<GatewayProvider>` and passed to `<Gateway>` and
`<GatewayDest>` invisibly via React's `contextTypes`.

Whenever a child or container is added or removed, React Gateway will
update its internal registry and ensure things are properly rendered.

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