Skip to content

violice/rmu

Repository files navigation

RMU (React modal utility)

RMU is a small, zero-dependency utility to control modals in React apps

Usage

import { openModal, closeModal, RMUOutlet, RMUProvider } from '@violice/rmu';

const Example = () => {
  return (
    <RMUProvider>
       <button
        onClick={() => {
          const modal = openModal(
            <TestModal onClose={() => closeModal(modal)} />
          );
        }}
      >
        Open modal
      </button>
      <SomeContextProvider>
        <button onClick={() => {
          const modal = openModal(
            <TestContextModal onClose={() => closeModal(modal)} />,
            { outletId: 'MY_OUTLET' },
          );
        }}>
          Open modal with access to some context
        </button>
        <RMUOutlet outletId="MY_OUTLET">
      </SomeContextProvider>
      <RMUOutlet />
    </RMUProvider>
  );
};

RoadMap

  • Custom events, new API (0.2.0)
  • Connected modals
  • Auto-close
  • Use for toasts example

License

Licensed under MIT

About

RMU is a small, zero-dependency utility to control modals in React apps

Resources

License

Stars

Watchers

Forks