dentibiotics_modal v0.1.14

A simple & lightweight method to display modal windows with React.

dentibiotics_modal is a quite simple modal, with content box and button. By default the modal window is screen's centered horizontaly and verticaly. It's really easy to customize it with all sorts of props.

Link to jQuery and npm repo :

Original jQuery modal on gitHub : jQuery

My React component : npm

Installation

You can install dentibiotics_modal with npm:

npm install dentibiotics_modal

How to

First you need to import the Modal :

import { Modal } from 'dentibiotics_modal';

Then you can use and customize the component :

<Modal 
    zindex={}
    backgroundAction={}
    modalStyle={}
    content={}
    contentStyle={}
    buttonStyle={}
    buttonAction={}
/>

z-index :

You can access the background className with props :

zindex={z-10}

It's an optional props, default value is 'z-index: 10;'

background eventListener :

You can add an action on the background if needed with props :

backgroundAction={your props}

modal screen style :

It's connected to the modal div className. I work with tailwindcss so I use this props for exemple :

modalStyle={'p-9 border-4 flex flex-col justify-center items-center border-green-900 border-opacity-70 bg-white rounded overflow-hidden bg-scroll'}

modal window content :

You can customize the modal content with props :

content={modalContent}

modal content style :

And the content style (it's linked to the content div' className).

contentStyle={'m-5'}

button style :

The button is fully customizable with this className's props :

buttonStyle={'w-24 p-2 opacity-80 hover:opacity-100 rounded px-5 bg-green-900 text-white'}

button eventListener :

You can add an action on the button

buttonAction={}

button text content :

And finally the button text

buttonContent={}

It's an optional props, default value is 'Close'

More informations

To show or hide your modal window i recommand this method. Add this in your parent component :

const [modal, setModal] = useState(false);
const [modalContent, setModalContent] = useState('');

const handleClick = () => {
    setModal(false);
    };

And to hide your modal on background or button click :

{modal && (
    <Modal
        backgroundAction={handleClick}
        modalStyle={custom-modal-style}
        content={modalContent}
        contentStyle={custom-content-style}
        buttonStyle={custom-button-style}
        buttonAction={handleClick}
        />
    )}