Nonstop Pajama Models

    react-stateless-modal

    1.1.3 • Public • Published

    react-stateless-modal

    A modal library that does not require state maintenance

    NPM JavaScript Style Guide

    Install

    npm install --save react-stateless-modal

    documentation

    Read the full Documentation here

    Advantages

    Create modals wherever you want without having to maintain state variables.

    Motivation

    The modal libraries in existence such as react-responsive-modal requires users to maintain state variables for the creation of each modal, which can become painful while maintaining a large codebase that involves multiple modals. This library eliminates the above problem and lets users create modals without having to create and maintain state variables.

    Usage

    import React, { Component } from "react";
    import { openModal } from "react-stateless-modal";
    class Example extends Component {
      openModal = () => {
        openModal({
          header: () => (
            /* component or string to render header */
          ),
          body: () => (
            /* component or string to render body */
          ),
          footer: () => (
            /* component or string to render footer */
          ),
          classNames: { overlay: className for overlay, modal: className for the modal, closeIcon: className for close icon},
          closeOnEscape: /* Setting true closes the modal on pressing escape key setting false does the opposite (Optional)*/,
          closeIcon: { src: IconObject, alt: alt text for the icon},
          animation: { name: choose from 'bounce', 'fade-in' and 'zoom' animation, duration: 'animationDuration'},
          containerId: /* Id of the custom container over which you would like the modal to be mounted */
          modalId: { /* make the modal take the id of your choosing */}
        });
      };
      render() {
        return <button onClick={this.openModal}>Open Modal</button>;
      }
    }

    The openModal method will mount the container for you.

    You may optionally choose to use the component mode of the library by importing and mounting the Modal component. you may use all the properties used in the object passed to the openModal function. The example below shows how to create a simple modal using component mode. You additionally need to pass open and onClose prop. Refer docs for more information.

    import React, { Component } from "react";
    import "./styles.css";
    import { Modal } from "react-stateless-modal";
     
    class App extends Component {
      state = {
        open: false
      };
     
      handleClose = () => {
        this.setState({ open: false });
      };
     
      handleOpen = () => {
        this.setState({ open: true });
      };
     
      render() {
        const { open } = this.state;
        return (
          <div>
            <button onClick={this.handleOpen}>Open Modal via Component mode</button>
            <Modal
              head="head"
              body="Inner Body  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam
              pulvinar risus non risus hendrerit venenatis. Pellentesque sit amet
              hendrerit risus, sed porttitor quam  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam
              pulvinar risus non risus hendrerit venenatis. Pellentesque sit amet
              hendrerit risus, sed porttitor quam  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
              onClose={this.handleClose}
              open={open}
            />
          </div>
        );
      }
    }
     
    export default App;

    Nested modal support

    The library additionally gives you the flexibility of mounting a modal container over an already existing modal. The example below describes the same

    import React, { Component } from 'react';
    import { openModal } from 'react-stateless-modal';
     
    export default class App extends Component {
      openModal = () => {
        openModal({
          head: () => <h2>Random Heading</h2>,
          body: () => (
            <p>
              Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam pulvinar risus non risus
              hendrerit venenatis. Pellentesque sit amet hendrerit risus, sed porttitor quam.
            </p>
          ),
          footer: () => <button onClick={this.openInnerModal}>Open Inner Modal</button>
        });
      };
     
      openInnerModal = () => {
        openModal({
          head: () => 'Inner Heading',
          body: () => <p>Inner Body</p>,
          footer: () => <p>Inner Footer</p>
        });
      };
     
      render() {
        return <button onClick={this.openModal}>Show</button>;
      }
    }

    License

    MIT © Sigkill32

    Keywords

    none

    Install

    npm i react-stateless-modal

    DownloadsWeekly Downloads

    3

    Version

    1.1.3

    License

    MIT

    Unpacked Size

    79.5 kB

    Total Files

    6

    Last publish

    Collaborators

    • cb-dev