1.0.8 • Published 4 months ago
@tenaspace/react-headless-modal v1.0.8
@tenaspace/react-headless-modal
This is an unstyled React component that helps you to easily make the Modal with your style.
Demo
See the DEMO
Installation
yarn add @tenaspace/react-headless-modalor via npm
npm install @tenaspace/react-headless-modalUsage
Example with Tailwind CSS (Recommend)
import { useState } from 'react'
import { HeadlessModal } from '@tenaspace/react-headless-modal'
const App = () => {
const [open, setOpen] = useState(false)
const handleOpen = () => setOpen(true)
const handleClose = () => setOpen(false)
return (
<>
<button onClick={handleOpen} className={`bg-black px-5 py-2.5 text-white`}>
open
</button>
<HeadlessModal open={open} onClose={handleClose} className={`relative z-[1055]`}>
<HeadlessModal.Backdrop
className={`fixed inset-0 bg-black/25 transition-opacity duration-200`}
enter={{
className: `opacity-100 ease-out`,
}}
leave={{
className: `opacity-0 ease-in`,
}}
/>
<div className={`fixed inset-0 overflow-y-auto overflow-x-hidden`}>
<div className={`flex min-h-full items-center justify-center p-3`}>
<HeadlessModal.Panel
className={`mx-auto w-full max-w-md bg-white p-8 shadow-2xl transition duration-300`}
enter={{
className: `scale-100 opacity-100 ease-out`,
}}
leave={{
className: `scale-95 opacity-0 ease-in`,
}}
>
{({ isOpened }) =>
isOpened ? ( // This props will render/remove the Panel's content when the Modal open/close. If you don't want your Panel's content re-rendered, remove this props with the condition check.
<div className={`space-y-4`}>
<div>
<h3 className={`mb-2 text-3xl font-bold`}>modal</h3>
<p>
lorem ipsum dolor sit amet, consectetur adipisicing elit. Perspiciatis, ipsum perferendis! Quo
omnis mollitia aperiam explicabo officia soluta, cumque, veritatis numquam doloribus distinctio
quasi cum sed rerum nihil ipsa. Maxime?
</p>
</div>
<button onClick={handleClose} className={`bg-black px-5 py-2.5 text-white`}>
close
</button>
</div>
) : null
}
</HeadlessModal.Panel>
</div>
</div>
</HeadlessModal>
</>
)
}
export default AppExample with Style inline
import { useState } from 'react'
import { HeadlessModal } from '@tenaspace/react-headless-modal'
const App = () => {
const [open, setOpen] = useState(false)
const handleOpen = () => setOpen(true)
const handleClose = () => setOpen(false)
return (
<>
<button
onClick={handleOpen}
style={{
cursor: `pointer`,
backgroundColor: `black`,
padding: `10px 20px`,
color: `white`,
}}
>
Open Modal
</button>
<HeadlessModal open={open} onClose={handleClose} style={{ position: `relative`, zIndex: 1055 }}>
<HeadlessModal.Backdrop
style={{
position: `fixed`,
top: 0,
right: 0,
bottom: 0,
left: 0,
backgroundColor: `rgb(0 0 0 / 0.25)`,
transitionProperty: `opacity`,
transitionDuration: `0.2s`,
}}
enter={{
style: {
opacity: 1,
transitionTimingFunction: `cubic-bezier(0, 0, 0.2, 1)`,
},
}}
leave={{
style: {
opacity: 0,
transitionTimingFunction: `cubic-bezier(0.4, 0, 1, 1)`,
},
}}
/>
<div
style={{
position: `fixed`,
top: 0,
right: 0,
bottom: 0,
left: 0,
overflowX: `hidden`,
overflowY: `auto`,
}}
>
<div
style={{
display: `flex`,
minHeight: `100%`,
alignItems: `center`,
justifyContent: `center`,
padding: `12px`,
}}
>
<HeadlessModal.Panel
style={{
margin: `0 auto`,
width: `100%`,
maxWidth: `448px`,
padding: `32px`,
backgroundColor: `white`,
boxShadow: `rgba(0, 0, 0, 0.1) 0px 10px 15px -3px, rgba(0, 0, 0, 0.05) 0px 4px 6px -2px`,
transitionProperty: `opacity, transform`,
transitionDuration: `0.3s`,
}}
enter={{
style: {
opacity: 1,
transform: `scale(1)`,
transitionTimingFunction: `cubic-bezier(0, 0, 0.2, 1)`,
},
}}
leave={{
style: {
opacity: 0,
transform: `scale(0.95)`,
transitionTimingFunction: `cubic-bezier(0.4, 0, 1, 1)`,
},
}}
>
{({ isOpened }) =>
isOpened ? ( // This props will render/remove the Panel's content when the Modal open/close. If you don't want your Panel's content re-rendered, remove this props with the condition check.
<div>
<div
style={{
margin: `0 0 16px 0`,
}}
>
<h3
style={{
margin: `0 0 8px 0`,
fontSize: `30px`,
lineHeight: `36px`,
fontWeight: `bold`,
}}
>
modal
</h3>
<p>
lorem ipsum dolor sit amet, consectetur adipisicing elit. Perspiciatis, ipsum perferendis! Quo
omnis mollitia aperiam explicabo officia soluta, cumque, veritatis numquam doloribus distinctio
quasi cum sed rerum nihil ipsa. Maxime?
</p>
</div>
<button
onClick={handleClose}
style={{
cursor: `pointer`,
backgroundColor: `black`,
padding: `10px 20px`,
color: `white`,
}}
>
close
</button>
</div>
) : null
}
</HeadlessModal.Panel>
</div>
</div>
</HeadlessModal>
</>
)
}
export default AppProps
| Name | Mandatory | Type | Default value | Component | Note |
|---|---|---|---|---|---|
| open | required | boolean | false | HeadlessModal | The state of the Modal |
| onClose | required | () => void | () => {} | HeadlessModal | Function handle to close the Modal |
| clickOutsideToClose | optional | boolean | true | HeadlessModal | Enable / Disable closing the Modal when clicking outside the Modal panel |
| container | optional | Element / DocumentFragment | document.body | HeadlessModal | The Modal will be rendered with the parent is <body> by default. You can choose the place where you want the Modal rendered by setting the Element to this props |
| id | optional | string / null / undefined | undefined | HeadlessModal | A unique string or number to be used as the Modal's key |
| enter | optional | { className?: string / null; style?: React.CSSProperties } | {} | HeadlessModal.Backdrop, HeadlessModal.Panel | The CSS will be shown when the Modal is on open (You can set the CSS using class or style inline) |
| leave | optional | { className?: string / null; style?: React.CSSProperties } | {} | HeadlessModal.Backdrop, HeadlessModal.Panel | The CSS will be shown when the Modal is on close (You can set the CSS using class or style inline) |
| as | optional | React.ElementType | div | All | Set the tag HTML like whatever you want |
| className | optional | string | null | All | |
| style | optional | React.CSSProperties | {} | All |