react-jsx-portal v2.0.0-alpha.1

This library is perfect both for creating modals and popouts, as well as for solutions for more complex tasks, such as complex interface components, when the layout requires the presentation of parts of the component in different places of the layout, which leads to the flow of the component state into the upstream components and props hell.

Features

• does not use DOM search. No document.querySelector, document.getElementById, ... No more need to search for elements in HTML markup, JSX ONLY
• predictability and declarativeness. Even if the component inside which the portal should be rendered is loaded lazily, you have nothing to worry about, as soon as this component is loaded, the render will happen automatically
• broadcasting. The same component can be rendered in several places at once.
• the ability to pass props from the component where the portal is rendered directly to the portal, avoiding props hell and without using the Context API and its attendant restrictions

Usage

To work, you need two components: Anchor and Portal. Anchor is a jsx element where Portal will be rendered. Give them the same id to match them. In the render props of the Portal component, pass a render function that takes as an argument an object with props that the Anchor component passes to it.

<App>
    <Anchor id="someId" someProp="My name is ..."} />
    ...
    {isOpen && <Portal id="someId" render={({ someProp }) => (<div>{someProp}</div>)} />}
</App>

If you need to draw the same portal in two places, just add another Anchor with the same id as Portal. Each rendered component will receive props from its Anchor component.

<App>
    <Anchor id="someId" someProp="My name is ..."} />
    ...
    <Anchor id="someId" someProp="What a wonderful place!?"} />
    ...
    {isOpen && <Portal id="someId" render={({ someProp }) => (<div>{someProp}</div>)} />}
</App>

Render multiple Portal's to multiple Anchor's.

<App>
    <Anchor id="someId" someProp="My name is ..."} />
    ...
    <Anchor id="someId" someProp="What a wonderful place!?"} />
    ...
    {isOpen && <Portal id="someId" render={({ someProp }) => (<div>{someProp}</div>)} />}
    {isSecondOpen && <Portal id="someId" render={({ someProp }) => (<div>{someProp}</div>)} />}
</App>

When rendering several Portal's in one Anchor, you can prioritize which one should be rendered now. To do this, pass in Portal, the prop meta, and in the Anchor component, the prop renderPolicy is a function that receives an array {Component, __meta}, ... as input and returns the same array.

const renderByPriority = (arr) => {
    const { length } = arr
    
    if (length) {
        const sortedByPriority = arr.sort((a, b) => b.__meta.priority - a.__meta.priority)

        return [sortedByPriority[0]]
    }

    return arr
}

...

<App>
    <Anchor __renderPolicy={renderByPriority} id="someId" someProp="My name is ..."} />
    ...
    {isOpen && <Portal __meta={{ priority: 1 }} id="someId" render={({ someProp }) => (<div>{someProp}</div>)} />}
    {isSecondOpen && <Portal __meta={{ priority: 10 }} id="someId" render={({ someProp }) => (<div>{someProp}</div>)} />}
</App>

Try on codesandbox: https://codesandbox.io/s/react-jsx-portal-yp34n

Данная библиотека отлично подойдёт как для создания модалок и попаутов, так и для решения куда более сложных задач, таких как создание сложных компонентов интерфейса, когда компоновка требует отображения частей компонента в разных местах макета, что ведёт к протеканию состояния компонента в вышестоящие компоненты и props hell.

Преимущества (Features)

• не использует поиск по DOM. Никаких document.querySelector, document.getElementById, ... Больше нет необходимости искать элементы в HTML-разметке, ТОЛЬКО JSX
• предсказуемость и декларативность. Даже если компонент, внутри которого должен быть отрисован портал грузится лениво вам не о чем беспокоиться, как только этот компонет загрузится рендер произойдёт автоматически
• broadcasting. Один и тот же компонент может быть отрисован сразу в нескольких местах.
• возможность передавать props из компонента куда отрисовывается портал напрямую в портал, избегая props hell и не используя Context API и сопутствующих ему ограничений

Как пользоваться (Usage)

Для работы вам понадобятся два компонента: Anchor и Portal. Anchor - это jsx элемент, в котором будет отрисовываться Portal. Для их сопоставления дайте им одинаковые id. В пропс render компонента Portal передайте рендер-функцию, которая принимает в качестве аргумента объект с props, которые ему передаёт компонент Anchor.

<App>
    <Anchor id="someId" someProp="My name is ..."} />
    ...
    {isOpen && <Portal id="someId" render={({ someProp }) => (<div>{someProp}</div>)} />}
</App>

При необходимости отрисовать один и тот же портал в двух местах просто добавьте ещё один Anchor с таким же id как у Portal. Каждый отрисованный компонент получит props от своего компонента Anchor.

<App>
    <Anchor id="someId" someProp="My name is ..."} />
    ...
    <Anchor id="someId" someProp="What a wonderful place!?"} />
    ...
    {isOpen && <Portal id="someId" render={({ someProp }) => (<div>{someProp}</div>)} />}
</App>

Рендер нескольких Portal's в несколько Anchor's.

<App>
    <Anchor id="someId" someProp="My name is ..."} />
    ...
    <Anchor id="someId" someProp="What a wonderful place!?"} />
    ...
    {isOpen && <Portal id="someId" render={({ someProp }) => (<div>{someProp}</div>)} />}
    {isSecondOpen && <Portal id="someId" render={({ someProp }) => (<div>{someProp}</div>)} />}
</App>

При отрисовке нескольких Portal's в один Anchor вы можете приоретизировать какой именно из них должен быть сейчас отрисован. Для этого передайте в Portal пропс meta, а в компонент Anchor пропс renderPolicy - функцию, которая на вход получает массив { Component, __meta }, ... и возвращает такой же массив.

const renderByPriority = (arr) => {
    const { length } = arr
    
    if (length) {
        const sortedByPriority = arr.sort((a, b) => b.__meta.priority - a.__meta.priority)

        return [sortedByPriority[0]]
    }

    return arr
}

...

<App>
    <Anchor __renderPolicy={renderByPriority} id="someId" someProp="My name is ..."} />
    ...
    {isOpen && <Portal __meta={{ priority: 1 }} id="someId" render={({ someProp }) => (<div>{someProp}</div>)} />}
    {isSecondOpen && <Portal __meta={{ priority: 10 }} id="someId" render={({ someProp }) => (<div>{someProp}</div>)} />}
</App>

Попробовать: Try on codesandbox: https://codesandbox.io/s/react-jsx-portal-yp34n