1.3.0 • Published 8 months ago

react-modalou v1.3.0

Weekly downloads
-
License
ISC
Repository
github
Last release
8 months ago

React-modalou

A modal is a dialog that overlays your application's content. It can be used to display information, collect user input, or perform other tasks.

Installation

To install react-modalou, you can use the following command:

npm i react-modalou

This component has the following props:

  • children: The content of the modal.
  • isOpen: Whether or not the modal is open.
  • modalStyle: Optional CSS styles for the modal container.
  • contentStyle: Optional CSS styles for the modal content.
  • close: A function that closes the modal.
  • title: An optional title for the modal.
  • CloseIcon: An optional close icon for the modal.
  • closeStyle: Optional CSS styles that will be applied to the close button of the modal.
  • closeOnEsc: Whether or not the modal should close when the escape key is pressed.
  • closeOnOverlayClick: Whether or not the modal should close when the overlay is clicked.
  • titleStyle: Optional CSS styles that will be applied to the title of the modal.

Here is an example of how to use this component:

import React from "react";
import { Modal } from "react-modalou";

const App = () => {
  const [isOpen, setIsOpen] = React.useState(false);
  return (
    <div>
      <button onClick={() => setIsOpen(true)}>open</button>
      <div>
        <Modal title="test" isOpen={isOpen} close={() => setIsOpen(false)}>
          <p>test react-modalou</p>
        </Modal>
      </div>
    </div>
  );
};


export default App;
PropTypeDescription
childrenReact.ReactNodeThe content of the modal.
isOpenbooleanWhether or not the modal is open.
modalStyleReact.CSSPropertiesOptional CSS styles for the modal container.
contentStyleReact.CSSPropertiesOptional CSS styles for the modal content.
close() => voidA function that closes the modal.
titlestringAn optional title for the modal.
CloseIconReact.ReactNodeAn optional close icon for the modal.
closeStyleReact.CSSPropertiesOptional CSS styles that will be applied to the close button of the modal.
closeOnEscbooleanWhether or not the modal should close when the escape key is pressed.
closeOnOverlayClickbooleanWhether or not the modal should close when the overlay is clicked.
titleStyleReact.CSSPropertiesOptional CSS styles that will be applied to the title of the modal.
1.3.0

8 months ago

1.2.5

8 months ago

1.2.0

8 months ago

1.1.0

9 months ago

1.0.5

9 months ago

1.0.0

9 months ago