madeleineostoja / react-portal-overlay

Lightweight fullscreen overlays using React portals

Home Page:https://madeleineostoja.github.io/react-portal-overlay/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

React Portal Overlay

NPM License

A lightweight and performant fullscreen overlay component using React portals to render anywhere you need them to

Installation

npm i react-portal-overlay

Usage

See the API Docs for a full overview of props and options.

import React, { useState } from 'react';
import { Overlay } from 'react-portal-overlay';

export default () => {
  const [open, setOpen] = useState(false);

  return (
    <Overlay open={open} onClose={() => setOpen(false)}>
      <h1>My overlay</h1>
    </Overlay>
  );
};

About

Lightweight fullscreen overlays using React portals

https://madeleineostoja.github.io/react-portal-overlay/

License:MIT License


Languages

Language:TypeScript 72.6%Language:JavaScript 26.1%Language:HTML 1.3%