README.md

react-use-modal

A react library for managing the state of your modals

Install

npm install --save @luisiacc/react-use-modal

Quick notes

The library doesn't care how you render your modal, it just handles the state to render it, and optionally pass data to it if required, sort of like react-query does on queries.

Usage

This is just a showcase, please refer to the docs to see how to cover most use cases

import React from "react"

import SomeModal from "some-modal"; // I'm just making this up, imagine is a real modal
import { useModal, ModalController } from "@luisiacc/react-use-modal"

function Example(props: any) {
  const modals = useModal()

  const doSomething = (data: any) => {
    // ...
  }

  return (
    <>
      <button onClick={() => modals.push("some-modal")}>Show something</button>
      <ModalController name="some-modal" render={modal => (
        <SomeModal visible onCancel={modal.cancel} onSave={(someData: any) => {
          doSomething(someData)
          modal.submit();
        }}>
      )} />
    </>
  )
}

• If you are using the <ModalController /> inside a router, and your modal does some kind of redirection, you should import ModalController from @luisiacc/use-react-modal/router like:

import {ModalController} from "@luisiacc/use-react-modal/router"