modalia-react v1.0.8

modalia-react

Modalia is a lightweight React library that leverages the native HTML <dialog> tag to create flexible and accessible modals. By using React Portals, Modalia ensures that the modal is directly attached to the body element of the DOM, allowing for clean integration without affecting the rest of the component tree. The library enforces that only one modal can be active at a time, providing a focused and streamlined user experience.

Modalia provides a simple API with a few key parameters for customization. The isOpen prop controls the visibility of the modal, while the onClose function is triggered when the user closes the modal (such as by clicking the close button). The title prop allows you to set a title for the modal, and the size prop can be used to adjust the modal’s dimensions, with options like small, medium, large, and xl. The modal content is passed as children, making it easy to customize what appears inside the dialog. Modalia ensures that only one modal can be active at a time, and the component uses React Portals to attach the modal directly to the DOM, ensuring proper stacking and isolation from the rest of your app's layout.

you can see a demonstration here: https://micheg.altervista.org/modalia_test/

Props

• size: horizontal space, can be one of: small, medium, large, or xl, default is: small
• verticalPosition: vertical alignment, can be one of: center, top, or bottom, default is center
• customClass: this parameter allows you to pass a class that will be applied to the element, default is void.

Events

• beforeOpen:
  • This callback is called before the modal opens. It’s executed right before the modal is rendered to the DOM and the body scroll is disabled.
  • It’s added to the useEffect hook, which runs when the isOpen state changes.
• onReady:
  • This callback is executed immediately after the first rendering of the modal. This ensures that the modal has been inserted into the DOM.
  • We use setIsRendered(true) in the useEffect hook to manage the state for this callback.
• beforeClose:
  • This callback is executed just before the modal starts closing.
  • It’s called inside the handleClose function, just before the onClose callback.
• onClose:
  • This callback is executed after the modal is closed. It’s the final step in the closing process, allowing any post-close logic to be handled.
  • It’s called after the beforeClose callback.

more props may be available in the future.

Installation

npm install modalia-react

Build

npm install
npm build

Usage

<Modalia
  isOpen={isOpen}
  onClose={() => {
    console.log('Modal is fully closed.');
    setIsOpen(false);
  }}
  beforeClose={() => console.log('Modal is about to close...')}
  title="My Modal"
  size="large"
  verticalPosition="bottom"
  beforeOpen={() => console.log('Modal is about to open...')}
  onReady={() => console.log('Modal has been rendered and is ready.')}
>
  <p>This is the content of the modal aligned to the bottom.</p>
</Modalia>

Example

import React, { useState } from "react";
import Modalia from 'modalia-react';
import 'modalia-react/dist/Modalia.css';

function App() {
  const [isOpen, setIsOpen] = useState(false);
  const [modalSize, setModalSize] = useState("small");

  const openModal = (size) => {
    setModalSize(size);
    setIsOpen(true);
  };

  return (
    <div className="App">
      <h1>Modalia Component Demo</h1>
      <button onClick={() => openModal("small")}>Open Small Modal</button>
      <button onClick={() => openModal("medium")}>Open Medium Modal</button>
      <button onClick={() => openModal("large")}>Open Large Modal</button>
      <button onClick={() => openModal("xl")}>Open XL Modal</button>

      <Modalia
        isOpen={isOpen}
        onClose={() => setIsOpen(false)}
        title={`This is a ${modalSize} Modal`}
        size={modalSize}
      >
        <p>
          This is content inside the {modalSize} modal. It is fully
          customizable!
        </p>
      </Modalia>
    </div>
  );
}

export default App;