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-use-modal-hook

v1.1.0

Published

react-use-modal

Downloads

22

Readme

react-use-modal-hook

Hook to wrap a component and show it as a modal.

It returns:

  • Wrapped component as a new component.
  • Display function.
  • Status as a boolean.

Table of Contents

Why useModal

With this hook, you can easily render components showing them as a modal:

  • View components as a modals.
  • Share logic to the modal component.
  • Call the showModal function to open the modal.

Usage

Install:

npm install --save react-use-modal-hook

or

yarn add react-use-modal-hook

How to use

For this example I'll be using Ant Design's Modal.

For the hook to work, the defined modal has to have visible and hide props;

Define Modal

import React from 'react';

import { Modal } from 'antd';

type Props = {
  visible: boolean;
  hide: () => void;
}

const CustomModal: React.FC<Props> = ({ visible, hide }) => (
  <Modal visible={visible} onCancel={hide}>
    Hello, World!
  </Modal>
)

export default CustomModal;

Use it in your component

import React from 'react';

import useModal from 'react-use-modal-hook';
import CustomModal from './CustomModal';

const YourComponent = props => {
  const [Modal, showModal, visible] = useModal(CustomModal);

  return (
    <div>
      <button onClick={showModal}>show modal</button>
      <Modal />
    </div>
  )
}

Pass more data to the modal

The hook allows you to pass additional prosps via the showModal function. The arguments to the function will be the Props of the modal, minus visible and hide.

Define Modal

import React from 'react';

import { Modal } from 'antd';

type Props = {
  visible: boolean;
  hide: () => void;
  title: string;
  content: string;
}

const CustomModal: React.FC<Props> = ({ visible, hide, title, content }) => (
  <Modal visible={visible} onCancel={hide} title={title}>
    {content}
  </Modal>
)

export default CustomModal;

Use it in your component

import React from 'react';

import useModal from 'react-use-modal-hook';
import CustomModal from './CustomModal';

const YourComponent = props => {
  const [Modal, showModal, visible] = useModal(CustomModal, { title: 'default', content: 'default' });

  return (
    <div>
      <button onClick={() => showModal({ title: 'Title1', content: 'Hello there!' })}>show1</button>
      <button onClick={() => showModal({ title: 'Title2', content: 'How you doing?' })}>show1</button>
      <Modal />
    </div>
  )
}