modal-react-sw49go v0.2.6

Modal React components created using create-react-app by SW49GO

Presentation :

This is a reusable React component that allows you to display a customizable Modal window in your application.

The component is TypeScript compatible and includes a type definition file (ModalReact.d.ts) for an improved development experience. In a TypeScript project, the TypeScript compiler will automatically use this definition file.

Examples Custom style :

Installing the package in your project:

npm i modal-react-sw49go

Prerequisites :

• Node.js v18.16.0

Dependencies to install :

• "react": "^18.2.0"
• "react-dom": "^18.2.0"
• "prop-types": "^15.8.1"

Imported the component into your project:

import { ModalReact } from 'modal-react-sw49go'
import { useState } from 'react'

function App(){
    const [isOpen,setIsOpen]=useState(false)
    
    return(
        <>
            <button onClick={() => setIsOpen(true)}>Open</button>

            <ModalReact 
            isOpen={isOpen}
            isOverlay={true}
            themeName={'headerTheme'}
            primary={'#ededed'}
            styleContainerHeader={{borderBottom:'2px solid #000'}}
            styleButton={{border:'none'}}
            modalTitle={'Your title here'}
            contentModal={'Your message here'}
            textButton={'Your text button here'}
            actionOnClose={function () {setIsOpen(false)}}
            />
        </>
    )
}
export default App

Using the different component options (Props):

You can directly use a Theme :

• 'themeName' (String) : The Name of the theme to use (basicTheme / headerTheme / buttonTheme or headerAndButtonTheme)

You can use the color properties represented in the example above :

• 'primary' / 'secondary' / 'thirdty' / 'fourthy' (String) : Colours for modal elements

Others props :

• 'isOpen' (Boolean) : Show the Modal or not
• 'isOverlay' (Boolean) : Show Overlay or not
• 'styleOverlay' (CssProperties) : Style to use for Overlay
• 'styleModalContainer' (CssProperties) : Style to use for global Modal container
• 'styleContainerHeader' (CssProperties) : Style to use for Header Modal container
• 'styleModalTitle' (CssProperties) : Style to use for Title container
• 'modalTitle' (String) : Title you want to display in Header Modal
• 'styleButton' (CssProperties) : Style to use for button to close the Modal
• 'textButton' (String) : Text you want to use in close button
• 'actionOnClose' (Function) : Function to use with the close button is clicked
• 'styleContainerContent' (CssProperties) : Style to use for container of Content Modal
• 'modalContent' (String) : Text you want to display in the Content Modal

Mobile Media Query can be changed with props :

• 'mobileStyleModalContainer' (CssProperties)
• 'mobileStyleContainerHeader' (CssProperties)
• 'mobileStyleContainerContent' (CssProperties)
• 'mobileStyleButton' (CssProperties)

Some properties have default style configurations to allow visualization of the Modal (defaultTheme):

• styleModalContainer : {position: 'fixed',top: '50%' ,left: '50%' ,transform: 'translate(-50%, -50%)',backgroundColor:'#000', color:'#FFF', display:'flex',flexDirection:'column',zIndex:'10'},
• styleOverlay:{position:'absolute',top:'0',left:'0',width:'100%',height:'100%', backgroundColor:'#ededed', opacity:'0.5',zIndex:'1'},
• styleModalTitle:{ color:'#FFF',padding:'0.1rem', fontSize:'0.8rem'},
• styleContainerContent:{padding:'0.6rem 1rem'},
• styleContainerHeader :{display:'flex',justifyContent:'space-between',alignItems:'center', width:'100%'},
• styleButton:{backgroundColor:'transparent',border:'none',color:'#FFF',cursor:'pointer'}