Overlays

Modal

Centered overlay that blocks the interface until dismissed, focusing attention on key info or actions, ideal for confirmations, alerts, and quick approvals

Basic

A modal is a pop-up window that demands your attention. You have to deal with it before doing anything else on the page.

Loading...

Installation

Install the component via the CLI in one command.

npx shadcn@latest add @intentui/modal

Composed components

When you install this component via the CLI, it automatically loads all composed components, so you don’t need to add them individually.

This component comes packed with several components to enhance functionality and provide a seamless experience.

Manual installation

Use this approach if you prefer to install and wire up the component yourself instead of using the CLI.

npm install react-aria-components

Anatomy

import { Button } from "@/components/ui/button"
import {
  Modal,
  ModalBody,
  ModalClose,
  ModalContent,
  ModalDescription,
  ModalFooter,
  ModalHeader,
  ModalTitle,
  ModalTrigger,
} from "@/components/ui/modal"
<Modal>
  <ModalTrigger>Open Modal</ModalTrigger>
  <ModalContent>
    <ModalHeader>
      <ModalTitle>Modal Title</ModalTitle>
      <ModalDescription>Modal Description</ModalDescription>
    </ModalHeader>
    <ModalBody>Modal Body</ModalBody>
    <ModalFooter>
      <ModalClose>Close</ModalClose>
      <Button>Confirm</Button>
    </ModalFooter>
  </ModalContent>
</Modal>

Alert dialog

Alert dialogs are meant to interrupt the user with a critical message, so use 'em only when it's absolutely necessary. The fix? Set the role to alertdialog, and you're golden.

Loading...

Notice how the modal is dismissible and the close button is hidden? That's 'cause the role is set to alertdialog.

<ModalOverlay isDismissable={false}/>

Controlled

You can control the modal programmatically.

Loading...

Sizes

The modal is set to lg by default. You can adjust it to any size from the available options.

Loading...

The overlay uses a subtle 1px blur by default. You can increase it or disable it entirely.

<Modal>
  <Button intent="outline">Rename</Button>
  <ModalContent overlay={{ className: "backdrop-blur-2xl" }}>

If you want to turn it off, use backdrop-blur-none. If you do not need any blur at all, the recommended approach is to remove the blur class from the component defaults.

-"bg-bg/15 backdrop-blur-[1px] motion-reduce:backdrop-blur-0",
+"bg-bg/15",

Or, you can override it per instance from the component usage:

<Modal>
  <Button intent="outline">Rename</Button>
  <ModalContent overlay={{ className: "backdrop-blur-none" }}>

Sticky

You can use the ModalBody component to make the modal sticky.

Loading...

Nested

You can also nest modals. Try open it and confirm!

Loading...

This setup’s super flexible. If you skip adding ModalTitle and just drop a string as its child, it'll auto-render as the title. Like this:

<ModalHeader>
  Title
</ModalHeader>

Wanna customize more? Throw in props like title and description for a tailored header:

<ModalHeader title='Title' description='Description' />

Triggered by menu

You can also trigger the modal by clicking on a menu item.

Loading...

It might be a good idea to extract the modal into a separate component for better organization.

interface ModalActionProps {
  state: string | null
  onOpenChange: () => void
  actionType: { description: string; action: () => void; confirmText: string; title: string }
  disabled: boolean
}

const ModalAction = (props: ModalActionProps) => (
  <ModalContent isOpen={props.state !== null} onOpenChange={props.onOpenChange}>
    <ModalHeader>
      <ModalTitle>{props.actionType?.title}</ModalTitle>
      <ModalDescription>{props.actionType?.description}</ModalDescription>
    </ModalHeader>
    <ModalFooter>
      <ModalClose>Cancel</ModalClose>
      <Button
        intent={props.state === "ban" ? "danger" : "primary"}
        className="min-w-24"
        isDisabled={props.disabled}
        onPress={props.actionType?.action}
      >
        {props.disabled ? <Loader variant="spin" /> : props.actionType?.confirmText}
      </Button>
    </ModalFooter>
  </ModalContent>
)

Then you can use it like this.

<ModalAction
  state={state}
  onOpenChange={closeModal}
  actionType={actionType(state)}
  disabled={loading}
/>

With that, now we can modify the actionType function to return the initial state.

const actionType = (t: string | null) => {
  const initialsState = {
    title: '',
    description: '',
    confirmText: '',
    action: () => {}
  }

  switch (t) {
    case 'delete': ...
    case 'ban': ...
    case 'restore': ...
    default:
      return initialsState
  }
}
Unlock the full power of
Design Intent UI

Build modern web apps faster with 1000+ resources across components, blocks, patterns, templates, and starter kits.

Learn more