npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-modal-navigator

v1.1.2

Published

React modal component management with an inbuilt routing system.

Downloads

18

Readme

react-modal-navigator

Demo Animation

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.