https://github.com/synthetic-borealis/portal-storm

A simple wrapper component for React portals.
https://github.com/synthetic-borealis/portal-storm

react react-component react-portals reactjs typescript

Last synced: 12 days ago
JSON representation

A simple wrapper component for React portals.

• Host: GitHub
• URL: https://github.com/synthetic-borealis/portal-storm
• Owner: synthetic-borealis
• License: mit
• Created: 2022-09-20T20:12:41.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-21T10:06:24.000Z (about 2 years ago)
• Last Synced: 2024-09-18T18:10:44.882Z (2 months ago)
• Topics: react, react-component, react-portals, reactjs, typescript
• Language: TypeScript
• Homepage:
• Size: 89.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Portal Storm

![GitHub](https://img.shields.io/github/license/synthetic-borealis/portal-storm)

[![npm version](https://badge.fury.io/js/portal-storm.svg)](https://badge.fury.io/js/portal-storm)

![Tests](https://github.com/synthetic-borealis/portal-storm/actions/workflows/test.yml/badge.svg)

[![codecov](https://codecov.io/github/synthetic-borealis/portal-storm/branch/main/graph/badge.svg?token=PYX24KQ6IS)](https://codecov.io/github/synthetic-borealis/portal-storm)

A simple wrapper component for React portals.

## Installation

Run ```yarn add portal-storm``` or ```npm i portal-storm```.

## Usage

__Note:__ Both the `container` and the `children` props are _required_.

```jsx

import React from 'react';

import Portal from 'portal-storm';

import logo from './assets/images/logo.png';

export default function App() {

  return (

    


      

        

      

      

    

  );

}

```