Components
Loading preview...
HeroUI v3 Modal — compound dialog/overlay with placements, backdrops, sizes, dismiss behavior, scroll behavior, controlled state and forms.
@reapollo
npx shadcn@latest add https://21st.dev/r/larsen66/heroui-modal"use client"
import React from "react"
import { CheckCircle } from "lucide-react"
import { Button } from "@heroui/react"
import { Modal, useOverlayState } from "@/components/ui/heroui-modal"
export default function Controlled() {
const [isOpen, setIsOpen] = React.useState(false)
const state = useOverlayState()
return (
<div className="flex max-w-md flex-col gap-8">
<div className="flex flex-col gap-3">
<h3 className="text-lg font-semibold text-foreground">With React.useState()</h3>
<p className="text-sm leading-relaxed text-pretty text-muted-foreground">
Control the modal using React's <code className="text-foreground">useState</code> hook for
simple state management. Perfect for basic use cases.
</p>
<div className="flex flex-col items-start gap-3 rounded-2xl bg-surface p-4 shadow-sm">
<div className="flex w-full items-center justify-between">
<p className="text-xs text-muted-foreground">
Status:{" "}
<span className="font-mono font-medium text-foreground">
{isOpen ? "open" : "closed"}
</span>
</p>
</div>
<div className="flex gap-2">
<Button size="sm" variant="secondary" onPress={() => setIsOpen(true)}>
Open Modal
</Button>
<Button size="sm" variant="tertiary" onPress={() => setIsOpen(!isOpen)}>
Toggle
</Button>
</div>
</div>
<Modal.Backdrop isOpen={isOpen} onOpenChange={setIsOpen}>
<Modal.Container>
<Modal.Dialog className="sm:max-w-[360px]">
<Modal.CloseTrigger />
<Modal.Header>
<Modal.Icon className="bg-accent-soft text-accent-soft-foreground">
<CheckCircle className="size-5" />
</Modal.Icon>
<Modal.Heading>Controlled with useState()</Modal.Heading>
</Modal.Header>
<Modal.Body>
<p>
This modal is controlled by React's <code>useState</code> hook. Pass{" "}
<code>isOpen</code> and <code>onOpenChange</code> props to manage the modal state
externally.
</p>
</Modal.Body>
<Modal.Footer>
<Button slot="close" variant="secondary">
Cancel
</Button>
<Button slot="close">Confirm</Button>
</Modal.Footer>
</Modal.Dialog>
</Modal.Container>
</Modal.Backdrop>
</div>
<div className="flex flex-col gap-3">
<h3 className="text-lg font-semibold text-foreground">With useOverlayState()</h3>
<p className="text-sm leading-relaxed text-pretty text-muted-foreground">
Use the <code className="text-foreground">useOverlayState</code> hook for a cleaner API
with convenient methods like <code>open()</code>, <code>close()</code>, and{" "}
<code>toggle()</code>.
</p>
<div className="flex flex-col items-start gap-3 rounded-2xl bg-surface p-4 shadow-sm">
<div className="flex w-full items-center justify-between">
<p className="text-xs text-muted-foreground">
Status:{" "}
<span className="font-mono font-medium text-foreground">
{state.isOpen ? "open" : "closed"}
</span>
</p>
</div>
<div className="flex gap-2">
<Button size="sm" variant="secondary" onPress={state.open}>
Open Modal
</Button>
<Button size="sm" variant="tertiary" onPress={state.toggle}>
Toggle
</Button>
</div>
</div>
<Modal.Backdrop isOpen={state.isOpen} onOpenChange={state.setOpen}>
<Modal.Container>
<Modal.Dialog className="sm:max-w-[360px]">
<Modal.CloseTrigger />
<Modal.Header>
<Modal.Icon className="bg-success-soft text-success-soft-foreground">
<CheckCircle className="size-5" />
</Modal.Icon>
<Modal.Heading>Controlled with useOverlayState()</Modal.Heading>
</Modal.Header>
<Modal.Body>
<p>
The <code>useOverlayState</code> hook provides dedicated methods for common
operations. No need to manually create callbacks—just use{" "}
<code>state.open()</code>, <code>state.close()</code>, or{" "}
<code>state.toggle()</code>.
</p>
</Modal.Body>
<Modal.Footer>
<Button slot="close" variant="secondary">
Cancel
</Button>
<Button slot="close">Confirm</Button>
</Modal.Footer>
</Modal.Dialog>
</Modal.Container>
</Modal.Backdrop>
</div>
</div>
)
}