simplest-react-modalbox
TypeScript icon, indicating that this package has built-in type declarations

1.0.8 • Public • Published

Installation

To install the simplest-react-modalbox package, you need to have Node.js and npm (Node Package Manager) installed on your machine. Run the following command in your project directory:

npm install simplest-react-modalbox

Basic Usage

Here is a simple example of how to use the simplest-react-modalbox in your React application:

  1. Import the Module:

    Import the Modal component from the simplest-react-modalbox package:

    import Modal from 'simplest-react-modalbox';
  2. Add Modal to Your Component:

    Use the Modal component in your React component. You can control the visibility of the modal using a state variable:

    import React, { useState } from 'react';
    import Modal from 'simplest-react-modalbox';
    
    const App = () => {
      const [modalOpen, setModalOpen] = useState(false);
    
      const toggleModal = () => {
        setModalOpen(!modalOpen);
      };
    
      return (
        <div>
          <button onClick={toggleModal}>Open Modal</button>
          <Modal 
            title="Modal Title"
            text="This is a simple modal box."
            isOpen={modalOpen}
            customStyles={{
              modal: { backgroundColor: 'rgba(0,0,0,0.5)' },
              content: { padding: '20px', borderRadius: '10px' },
              close: { fontSize: '20px', cursor: 'pointer' }
            }}
          />
        </div>
      );
    };
    
    export default App;
  3. Styling the Modal:

    The simplest-react-modalbox comes with basic styling, but you can customize it according to your needs.

Props

The Modal component accepts the following props:

  • title (string): The title text to be displayed in the modal.
  • text (string): The main content text to be displayed in the modal.
  • isOpen (boolean): Controls the visibility of the modal.
  • customStyles (object): An optional object to apply custom styles to the modal, its content, and the close button. The object can have the following properties:
    • modal (React.CSSProperties): Styles for the modal background.
    • content (React.CSSProperties): Styles for the modal content.
    • close (React.CSSProperties): Styles for the close button.

Readme

Keywords

none

Package Sidebar

Install

npm i simplest-react-modalbox

Weekly Downloads

4

Version

1.0.8

License

ISC

Unpacked Size

10.6 kB

Total Files

12

Last publish

Collaborators

  • cibele1250