React-screen-modal NPM

react-screen-modal

with just one component we can create a modal or drawer with different positions, directions and usage.

Install

npm install --save react-screen-modal

props

=> simple Modal props :

onClose : type => void , required
show : type=> boolean , required
closeButton : type=> boolean , default => true

=> Drawer/modal props :

type : type=> string => default => "drawer-left" with full screen size => can be (drawer-right,drawer-left,drawer-top,drawer-bottom,modal,modal-left-bottom,modal-bottom-left,modal-right-bottom,modal-right-top,modal-top-right,modal-left-top,modal-top-left,modal-bottom-right)
duration : type => int ,default => 0 "in seconds"
direction : type => string , default => "left" => can be {left,right,top,bottom,center}
position : typr => string , default => "left" | "top" => can be {left,right,top,bottom,center}
width : type => int | string , default => "100%"
height : type => int | string , default => "100vh"
show : type => boolean ,default => false
backgroundDisable : type => boolean , default => false
color : type => string ,default => white
onClose : type => method (void) => requierd if backgroundDisable is true

notes

you can use type prop or customize the display with your own using direction and position with custom size.
when using type the width and height are auto , to customize the size with the type prop add your div inside the DrawerModal tag and set the custom width and height.
to make it responsive use % or auto for the modal/drawer and then control the content using media queries for example.
if you want to use drawer with the same variable of modal or trying to display modal from the drawer then turn backgroundDisable for the drawer to false.

Usage :

I - simple Modal

import React from "react";
import { Modal } from 'react-screen-modal';

export default App =()=>{

const [show,setshow]=useState(false)

// show
const openmodal=()=>{
  setshow(true);
}
// hide
const closemodal =()=>{
  setshow(false)
}

return <div>

 <button onClick={()=>openmodal()}>open modal<button>

<Modal
show={show}
onClose={closemodal}
closeButton={true}  // can be false
>
{/* your content here */}
</Modal>

</div>

}

II - Drawer / modal

you can use width and height width position and direction to customize the modal/drawer

import React,{useState} from 'react'
import { DrawerModal,DrawerItem } from 'react-screen-modal'


const App = () => {

const [show,setshow]=useState(false)

// show
const openmodal=()=>{
  setshow(true);
}
// hide
const closemodal =()=>{
  setshow(false)
}

  return (
    <div>
   {/* button to show and close the drawer */}
   <button style={{ width:200,color:"green" }} onClick={()=>openmodal()} >show</button>

  <DrawerModal
    width={500}
    height={500}
    direction="ceneter"
    position="center"
    duration={2}
    show={show}
    backgroundDisable={show}
    onClose={closemodal}
    color="red"
    >
    {/* the content must be changed by your ownt */}
    <input type="button" onClick={()=>closemodal()} value="Close it" />

    {/*optional*/}
    <DrawerItem>
    {/* you can use the drawer item for make it easy to read and organized with some existing css */}
    </DrawerItem>

  </DrawerModal>


    </div>
  )
}

export default App

you can also use type :

drawer from the left of screen

<DrawerModal
    type="drawer-left"
    duration={1}
    show={show}
    backgroundDisable={show}
    onClose={closemodal}
    color="aqua"
    >
    {/*your content here*/}
</DrawerModal>

drawer from the right of screen

<DrawerModal
    type="drawer-right"
    duration={1}
    show={show}
    backgroundDisable={show}
    onClose={closemodal}
    color="aqua"
    >
{/*your content here*/}
</DrawerModal>

drawer from the top of screen

<DrawerModal
    type="drawer-top"
    duration={1}
    show={show}
    backgroundDisable={show}
    onClose={closemodal}
    color="aqua"
    >
{/*your content here*/}
</DrawerModal>

drawer from the bottom of screen

<DrawerModal
    type="drawer-bottom"
    duration={1}
    show={show}
    backgroundDisable={show}
    onClose={closemodal}
    color="aqua"
    >
{/*your content here*/}
</DrawerModal>

a modal from the top of screen

<DrawerModal
    type="modal"
    duration={1}
    show={show}
    backgroundDisable={show}
    onClose={closemodal}
    color="aqua"
    >
{/*your content here*/}
</DrawerModal>

a full screen drawer from left

<DrawerModal
    direction="left"
    duration={1}
    show={show}
    color="aqua"
    >
{/*your content here*/}
</DrawerModal>

a full screen drawer from top

<DrawerModal
    direction="top"
    duration={1}
    show={show}
    color="aqua"
    >
{/*your content here*/}
</DrawerModal>

a full screen drawer from bottom

<DrawerModal
    direction="bottom"
    duration={1}
    show={show}
    onClose={closemodal}
    color="aqua"
    >
{/*your content here*/}
</DrawerModal>

a full screen drawer from right

<DrawerModal
    direction="right"
    duration={1}
    show={show}
    onClose={closemodal}
    color="aqua"
    >
{/*your content here*/}
</DrawerModal>

a modal in the left top corner (top left)

<DrawerModal
    width={300}
    height={200}
    direction="left" //top
    position="top"  // left
    duration={1}
    show={show}
    color="aqua"
    >
{/*your content here*/}
</DrawerModal>

a modal in the left bottom corner (bottom left)

<DrawerModal
    width={300}
    height={200}
    direction="left" // bottom
    position="bottom" //left
    duration={1}
    show={show}
    color="aqua"
    >
{/*your content here*/}
</DrawerModal>

a modal in the right top corner (top right)

<DrawerModal
    width={300}
    height={200}
    direction="right" // top
    position="top" //right
    duration={1}
    show={show}
    color="aqua"
    >
{/*your content here*/}
</DrawerModal>

a modal in the right bottom corner (bottom right)

<DrawerModal
    width={300}
    height={200}
    direction="right"  // bottom
    position="bottom" // right
    duration={1}
    show={show}
    color="aqua"
    >
{/*your content here*/}
</DrawerModal>

the following example about showing modal in the top left corner from top using the type prop

 <DrawerModal
    type="modal-top-left"
   width="auto"  // by default it's 45%
   height="auto" // by default it's 40%
  duration={1}
  show={show}
  color="red"
    >
</DrawerModal>

you can also use in type :

modal-top-right : will display the modal in the top right corner with the top direction in open and close.
modal-right-top :will display the modal in the top right corner with the right direction in open and close.
modal-top-left : will display the modal in the top left corner with the top direction in open and close.
modal-left-top : will display the modal in the top left corner with the left direction in open and close.
modal-bottom-right:will display the modal in the bottom right corner with the bottom direction in open and close.
modal-right-bottom:will display the modal in the bottom right corner with the right direction in open and close.
modal-bottom-left:will display the modal in the bottom left corner with the bottom direction in open and close.
modal-left-bottom:will display the modal in the bottom left corner with the left direction in open and close.
modal : will display the modal in the center .