react-modal-navigator v1.1.2

react-modal-navigator

react-modal-navigator is a highly customizable and easy-to-use Modal library for React. This library offers a built-in routing system that allows for multi-step modal dialogs. It comes with a provider to be wrapped around your application that gives access to the useModal() hook, which simplifies setting and accessing modals.

Live Demo

Check out the live demo here.

Installation

You can install react-modal-navigator using npm or yarn.

If you are using npm:

npm install react-modal-navigator

If you are using yarn:

yarn add react-modal-navigator

Usage

Firstly, wrap your application with the ModalProvider:

import { ModalProvider } from "react-modal-navigator";

function App() {
  return <ModalProvider>{/* Your app */}</ModalProvider>;
}

You can then use the useModal hook in your components:

import { useModal } from 'react-modal-navigator';

function ExampleComponent() {
  const { push, pop, clear } = useModal();

  return (
    /* Your component */
  );
}

The useModal hook provides three methods:

• push: Opens a new modal page.
• pop: Navigates back in the modal navigation stack.
• clear: Closes the modal and clears the navigation stack.

Based on the code you have provided, here is a simplified example that demonstrates the usage of the useModal hook. This example can be added to the readme file under the 'Example Usage' section:

Example Usage

Here's a basic usage example of the useModal hook in a component:

import { useModal } from "react-modal-navigator";

const MyComponent = () => {
  const { push, clear } = useModal({
    cancel_booking: () => (
      <div>
        <p>Are you sure that you wish to cancel this booking?</p>

        <button onClick={() => clear()}>No</button>

        <button
          onClick={() => {
            // cancel booking logic
            clear();
          }}
        >
          Yes
        </button>
      </div>
    ),
  });

  const handleCancelBooking = () => {
    push({
      id: "cancel_booking",
      modal: {
        title: "Cancel Booking",
      },
    });
  };

  return (
    <div>
      {/* Your component */}
      <button onClick={handleCancelBooking}>Cancel Booking</button>
    </div>
  );
};

In this example, when the 'Cancel Booking' button is clicked, the handleCancelBooking function is invoked, which uses the push function provided by the useModal hook to open a new modal page. The modal page is defined by the cancel_booking key in the object passed to useModal. The modal contains a confirmation message and two buttons - one to close the modal without doing anything (No button) and the other to perform some cancel booking logic and then close the modal (Yes button).

Options

PageRoute options include:

• id: Unique id of the page.
• title: Title of the page.
• actions: An object of actions for the page, where the key is the action name, and the value is a ReactNode.
• props: Props for the page.
• indismissable: If set to true, the modal can't be dismissed by the user.
• onClose: Function that gets called when the modal is closed.
• modal: An object of modal options (shown below)

This library provides multiple options to customize your Modals:

• title: The title of the modal.
• leading: A JSX element that is placed at the leading of the modal.
• trailing: A JSX element that is placed at the trailing of the modal.
• style: An object allowing for granular control over various parts of the modal's styles. This includes:
  • modalContainer: Style properties for the outer container of the modal.
  • modalContent: Style properties for the inner content of the modal.
  • modalHeader: Style properties for the header of the modal.
  • modalLeading: Style properties for the leading JSX element of the modal.
  • modalTrailing: Style properties for the trailing JSX element of the modal.
  • modalTitle: Style properties for the title of the modal.
  • modalDivider: Style properties for the divider in the modal.
  • modalBody: Style properties for the body of the modal.
  • openAnimation: Style properties for the opening animation of the modal.
  • closeAnimation: Style properties for the closing animation of the modal.

Running the Demo Locally

1. First, clone the repository:

   git clone https://github.com/vucinatim/react-modal-navigator.git

2. Navigate into the root directory of the project:

   cd react-modal-navigator

3. Install the dependencies:

   yarn install

4. Link the package for local development:

   yarn link

5. Start the package in development mode with hot reloading:

   yarn dev

   Leave this process running. It will rebuild your package whenever you save a file, allowing your demo to stay up-to-date with your changes.

6. In a new terminal window, navigate to your demo directory:

   cd demo

7. Install the dependencies in the demo:

   yarn install

8. Link the local package to the demo:

   yarn link "react-modal-navigator"

9. Run the demo:

   yarn start

This will start the demo application on your local development server.

With this setup, any changes you make to the react-modal-navigator package will be automatically reflected in your locally running demo application, thanks to the hot reloading feature.