0.1.9 • Published 10 months ago

react-modal-sabrinamouginot v0.1.9

Weekly downloads
-
License
-
Repository
-
Last release
10 months ago

Using react-modal-sabrinamouginot in a Project

WITH create-react-app (CRA)

1/1 Create a New Project with CRA If you haven't installed create-react-app yet, start by installing it globally:

npm install -g create-react-app

Next, create your new project:

npx create-react-app my-new-project
cd my-new-project

1/2 Install the Library In your project, install the library using the following command:

npm install react-modal-sabrinamouginot

1/3 Use the Modal in Your Project Then, use the modal in a component. For example, in src/App.js:

import React, { useState } from 'react';
import { Modal } from 'react-modal-sabrinamouginot';
import 'react-modal-sabrinamouginot/dist/style.css';

function App() {
  const [isOpen, setIsOpen] = useState(false);

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

  const closeModal = () => {
    setIsOpen(false);
  };

  return (
    <div>
      <h1>Using My Modal Library</h1>
      <button onClick={openModal}>Open Modal</button>
      <Modal isOpen={isOpen} onClose={closeModal}>
        <h2>This is a modal!</h2>
      </Modal>
    </div>
  );
}

export default App;

1/4 Run Your Project Finally, run the following command to launch your project:

npm start

WITH Vite

2/1 Create a New Project with Vite First, install Vite and create your testmodal-vite project:

npm create vite@latest testmodal-vite -- --template react
cd testmodal-vite

Then, install the dependencies:

npm install

2/2 Install the Library In your Vite project, install the library with the following command:

npm install react-modal-sabrinamouginot

2/3 Use the Modal in Your Project Next, in src/App.jsx, you can use the modal just like in CRA:

import React, { useState } from 'react';
import { Modal } from 'react-modal-sabrinamouginot';
import 'react-modal-sabrinamouginot/dist/style.css';

function App() {
  const [isOpen, setIsOpen] = useState(false);

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

  const closeModal = () => {
    setIsOpen(false);
  };

  return (
    <div>
      <h1>Using My Modal Library with Vite</h1>
      <button onClick={openModal}>Open Modal</button>
      <Modal isOpen={isOpen} onClose={closeModal}>
        <h2>This is a modal!</h2>
      </Modal>
    </div>
  );
}

export default App;

2/4 Run Your Project Finally, start your Vite project with the following command:

npm run dev

Props

The Modal component accepts the following props:

Prop Type Description isOpen Boolean Controls whether the modal is open (true) or closed (false). onClose Function Callback function triggered when the modal is closed by the user. Detailed Example

<Modal isOpen={isOpen} onClose={handleClose} >
  <h1>Welcome to the Modal</h1>
  <p>This is a simple modal example.</p>
  <button onClick={handleClose} >Close</button>
</Modal>

License MIT

0.1.9

10 months ago

0.1.8

10 months ago

0.1.7

10 months ago

0.1.6

11 months ago

0.1.5

11 months ago

0.1.4

11 months ago

0.1.3

11 months ago

0.1.2

11 months ago

0.1.1

11 months ago

0.1.0

11 months ago

0.0.1

11 months ago