npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-portal-hook

v1.0.8

Published

A small react portal library made with hooks

Downloads

799

Readme

react-portal-hook

A small React portal library made with hooks. Allows you to render an indefinite number of portals without having to define them in advance. Useful for event-driven notifications or modals where you don't know how many items will be rendered at a given time.

Getting Started

Installation

To use react-portal-hook in your project, run:

npm install react-portal-hook

Setup

Wrap your root component with PortalProvider.

// app.jsx

import { PortalProvider } from "react-portal-hook";

const App = () => {
  return (
    <PortalProvider>
      <RootComponent />
    </PortalProvider>
  );
};

Usage

Example - Modals:

By default, portals will be appended to document.body.

Demo

// page.jsx

import { usePortals } from "react-portal-hook";

const Modal = ({ closeModal }) => {
  return (
    <div>
      <h2>Title</h2>
      <p>This is a modal</p>
      <button onClick={closeModal}>Close Modal</button>
    </div>
  );
};

export const Page = () => {
  const portalManager = usePortals();

  const openModal = () => {
    portalManager.open(portal => <Modal closeModal={portal.close} />);
  };

  return (
    <div>
      <h2>Title</h2>
      <p>This is a page</p>
      <button onClick={openModal}>Open Modal</button>
    </div>
  );
};

Example - Notifications:

You can specify a DOM node in which to render portals with the appendTo option:

Demo

// layout.jsx

import { useRef } from "react";
import { usePortals } from "react-portal-hook";

const Notification = ({ closeNotification }) => {
  return (
    <div>
      <p>
        This is a notification{" "}
        <button onClick={closeNotification}>Close Notification</button>
      </p>
    </div>
  );
};

export const Layout = () => {
  const portalManager = usePortals();
  const notificationEl = useRef();

  const showNotification = () => {
    // Calling this from anywhere in your app will render a notification
    portalManager.open(
      portal => <Notification closeNotification={portal.close} />,
      {
        appendTo: notificationEl.current
      }
    );
  };

  return (
    <div>
      <div id="notification-holder" ref={notificationEl} />
      <button onClick={showNotification}>Show Notification</button>
    </div>
  );
};

API Documentation

portalManager

interface PortalManager {
  /**
   * The react element you want to render in the portal
   */
  element: ((portal: Portal) => React.ReactElement) | React.ReactElement;
  options?: {
    /**
    * An ID to avoid duplicate portals
    */
    id?: string;
    /**
    * A DOM node in which to render the portal
    */
    appendTo?: Element;
    /**
    * A callback that is fired when the portal closes
    */
    onClose?: () => void;
  };
}

Portal

interface Portal {
  /**
  * A function to close the Portal
  */
  close: () => void;
}