/overlay-kit

A declarative way to manage overlays in React.

Primary LanguageTypeScriptMIT LicenseMIT

overlay-kit · MIT License

English | 한국어

overlay-kit is a library that lets you manage overlays in a simple and declarative way using React.

import { overlay } from 'overlay-kit';

<Button 
  onClick={() => {
    overlay.open(({ isOpen, close }) => {
      return <Dialog open={isOpen} onClose={close} />;
    })
  }}
>
  Open
</Button>

Here are the features overlay-kit provides:

  • Hassle-free: overlay-kit makes overlay management straightforward with a simple function call: just call overlay.open(...). See the overlay problem for details.
  • Maximum Compatibility: overlay-kit is compatible with the majority of overlay types. From Material UI to custom component libraries, overlay-kit can handle almost all types of overlays.
  • Promise Integration: overlay-kit is easy to use with promises when getting results from overlays.
  • Robust Built-in Types: overlay-kit offers robust types for all functions, ensuring type safety and enhancing the developer experience.

License

MIT © Viva Republica, Inc. See LICENSE for details.

Toss