Dialog

A simplified wrapper for Shadcn Dialog with flexible option handling and automatic type conversion

Installation

npx shadcn@latest add @glrk-ui/dialog

If you haven't set up the prerequisites yet, check out Prerequest section.

Copy and paste the following code into your project.

ui/dialog.tsx

"use client"

import * as React from "react"
import { Dialog as DialogPrimitive } from "@base-ui/react/dialog"
import { XIcon } from "lucide-react"

import { cn } from "@/lib/utils"

import { Button } from "@/components/ui/button"

function Dialog(props: DialogPrimitive.Root.Props) {
  return <DialogPrimitive.Root data-slot="dialog" {...props} />
}

function DialogTrigger(props: DialogPrimitive.Trigger.Props) {
  return <DialogPrimitive.Trigger data-slot="dialog-trigger" {...props} />
}

function DialogPortal(props: DialogPrimitive.Portal.Props) {
  return <DialogPrimitive.Portal data-slot="dialog-portal" {...props} />
}

function DialogClose(props: DialogPrimitive.Close.Props) {
  return <DialogPrimitive.Close data-slot="dialog-close" {...props} />
}

function DialogOverlay({ className, ...props }: DialogPrimitive.Backdrop.Props) {
  return (
    <DialogPrimitive.Backdrop
      data-slot="dialog-overlay"
      className={cn(
        "fixed inset-0 bg-black/10 duration-100 supports-backdrop-filter:backdrop-blur-xs data-open:animate-in data-open:fade-in-0 data-closed:animate-out data-closed:fade-out-0",
        className
      )}
      {...props}
    />
  )
}

function DialogContent({
  className,
  children,
  showCloseButton = true,
  ...props
}: DialogPrimitive.Popup.Props & {
  showCloseButton?: boolean
}) {
  return (
    <DialogPortal>
      <DialogOverlay />
      <DialogPrimitive.Popup
        data-slot="dialog-content"
        className={cn(
          "fixed top-1/2 left-1/2 grid w-full max-w-[calc(100%-2rem)] -translate-x-1/2 -translate-y-1/2 gap-4 rounded-xl bg-background p-4 text-sm ring-1 ring-foreground/10 duration-100 outline-none sm:max-w-sm data-open:animate-in data-open:fade-in-0 data-open:zoom-in-95 data-closed:animate-out data-closed:fade-out-0 data-closed:zoom-out-95",
          className
        )}
        {...props}
      >
        {children}
        {showCloseButton && (
          <DialogPrimitive.Close
            data-slot="dialog-close"
            render={
              <Button
                variant="ghost"
                className="absolute top-2 right-2"
                size="icon-sm"
              />
            }
          >
            <XIcon />
            <span className="sr-only">Close</span>
          </DialogPrimitive.Close>
        )}
      </DialogPrimitive.Popup>
    </DialogPortal>
  )
}

function DialogHeader({ className, ...props }: React.ComponentProps<"div">) {
  return (
    <div
      data-slot="dialog-header"
      className={cn("flex flex-col gap-2", className)}
      {...props}
    />
  )
}

function DialogFooter({ className, ...props }: React.ComponentProps<"div">) {
  return (
    <div
      data-slot="dialog-footer"
      className={cn(
        "-mx-4 -mb-4 flex flex-col-reverse gap-2 rounded-b-xl border-t bg-muted/50 px-4 py-2.5 sm:flex-row sm:justify-end",
        className
      )}
      {...props}
    />
  )
}

function DialogTitle({ className, ...props }: DialogPrimitive.Title.Props) {
  return (
    <DialogPrimitive.Title
      data-slot="dialog-title"
      className={cn(
        "text-base leading-none font-medium",
        className
      )}
      {...props}
    />
  )
}

function DialogDescription({ className, ...props }: DialogPrimitive.Description.Props) {
  return (
    <DialogPrimitive.Description
      data-slot="dialog-description"
      className={cn(
        "text-sm text-muted-foreground *:[a]:underline *:[a]:underline-offset-3 *:[a]:hover:text-foreground",
        className
      )}
      {...props}
    />
  )
}

type DialogFooterWrapperProps = {
  cancel?: React.ReactNode
  action?: React.ReactNode
  footerCls?: string
  actionCls?: string
  cancelCls?: string
  onAction?: () => void
  onCancel?: () => void
}

function DialogFooterWrapper({
  cancel,
  action,
  footerCls,
  actionCls,
  cancelCls,
  onAction = () => { },
  onCancel = () => { },
}: DialogFooterWrapperProps) {
  return (
    <DialogFooter className={footerCls}>
      {
        cancel &&
        <DialogClose
          render={
            <Button
              variant="outline"
              onClick={onCancel}
              className={cn(cancelCls)}
            >
              {cancel}
            </Button>
          }
        />
      }

      {
        action &&
        <Button
          onClick={onAction}
          className={actionCls}
        >
          {action}
        </Button>
      }
    </DialogFooter>
  )
}

type DialogWrapperProps = {
  title?: React.ReactNode
  trigger?: React.ReactNode
  triggerCls?: string
  children?: React.ReactNode
  description?: React.ReactNode
  descriptionCls?: string
  contentCls?: string
  headerCls?: string
  titleCls?: string
} & DialogFooterWrapperProps

function DialogWrapper({
  trigger,
  title,
  description,
  children,
  triggerCls,
  contentCls,
  headerCls,
  titleCls,
  descriptionCls,

  cancel = "Cancel",
  action,
  footerCls,
  actionCls,
  cancelCls,
  onAction,
  onCancel,
  ...props
}: React.ComponentProps<typeof DialogPrimitive.Root> & DialogWrapperProps) {
  return (
    <Dialog {...props}>
      {
        trigger &&
        <DialogTrigger className={triggerCls}>{trigger}</DialogTrigger>
      }

      <DialogContent className={contentCls}>
        <DialogHeader className={headerCls}>
          <DialogTitle className={titleCls}>{title}</DialogTitle>
          {description && (
            <DialogDescription className={descriptionCls}>
              {description}
            </DialogDescription>
          )}
        </DialogHeader>

        {children}

        {
          (!!cancel || !!action) &&
          <DialogFooterWrapper
            cancel={cancel}
            action={action}
            footerCls={footerCls}
            actionCls={actionCls}
            cancelCls={cancelCls}
            onAction={onAction}
            onCancel={onCancel}
          />
        }
      </DialogContent>
    </Dialog>
  )
}

export {
  Dialog,
  DialogClose,
  DialogContent,
  DialogDescription,
  DialogFooter,
  DialogHeader,
  DialogOverlay,
  DialogPortal,
  DialogTitle,
  DialogTrigger,
  DialogWrapper,
  DialogFooterWrapper,
}

Usage

Basic

import { DialogWrapper } from "@/components/ui/dialog";
import { Button } from "@/components/ui/button";

export function Basic() {
  return (
    <DialogWrapper
      trigger={<Button>Delete</Button>}
      title="Are you absolutely sure?"
      description="This action cannot be undone. This will permanently delete your account and remove your data from our servers."
    />
  )
}

Controlled

import { useState } from "react"
import { DialogWrapper } from "@/components/ui/dialog";
import { Button } from "@/components/ui/button";

export function Controlled() {
  const [open, setOpen] = useState(false)

  return (
    <DialogWrapper
      open={open}
      onOpenChange={setOpen}
      trigger={<Button>Controlled</Button>}
      onAction={() => setOpen(false)}
      title="Are you absolutely sure?"
      description="This action cannot be undone. This will permanently delete your account and remove your data from our servers."
    />
  )
}

// Programaticaly open model without trigger
export function Controlled2() {
  const [open, setOpen] = useState(false)
 
  const updateOpen = () => setOpen(p => !p)

  return (
    <>
      <Button onClick={updateOpen}>Controlled 2</Button>

      <DialogWrapper
        open={open}
        onOpenChange={updateOpen}
        onAction={updateOpen}
        title="Are you absolutely sure?"
        description="This action cannot be undone. This will permanently delete your account and remove your data from our servers."
      />
    </>
  )
}

Custom

export function Custom() {
  return (
    <DialogWrapper
      trigger={<Button>Delete</Button>}
      title="Some Custom Modal"

      // to remove footer make cancel empty
      cancel=""
    >
      <div>...</div>
    </DialogWrapper>
  )
}

Reference

DialogFooterWrapper

Prop

Type

DialogWrapper

Prop

Type

Properties of DialogFooterWrapper can be passed directly.

Dialog

On this page