YuhuanStudioYunUIDocs
Overlays

Modal

YunUI's controlled modal — a portalled card with title, scrollable body and footer.

YunUI's own controlled modal — a portalled, centered card with a header (title + optional subtitle), a scrollable body, and an optional footer. It locks body scroll, closes on backdrop click or the Escape key, animates open and closed, and is SSR-safe. Unlike the Radix Dialog, you own the open state via isOpen + onClose.

Import

tsx1 line
import { Modal } from "@yuhuanowo/yunui";

Basic

A Modal is fully controlled: keep its isOpen in state and pass onClose to flip it back. The example below wires a trigger button to local state.

Controlled modal

tsx30 linesScroll horizontally
"use client";

import { useState } from "react";
import { Modal, Button } from "@yuhuanowo/yunui";

export function ModalDemo() {
const [open, setOpen] = useState(false);
return (

Props

PropTypeDefaultDescription
children*ReactNode—Modal content
classNamestring—Additional CSS classes
footerReactNode—Optional footer content
isClosingboolean—Whether modal is in closing animation state
isOpen*boolean—Whether the modal is open
maxHeightstring85vhCustom max-height override
onBackdropClick(() => void)—Called when backdrop is clicked (defaults to onClose)
onClose*() => void—Callback when modal should close
setIsClosing((closing: boolean) => void)—Callback to set closing state
showCloseButtonbooleantrueWhether to show the close button
showUnsavedBadgebooleanfalseWhether to show unsaved changes badge
size"sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "5xl" | "6xl" | "full"lgModal size
subtitlestring—Optional subtitle displayed below title
title*string—Modal title (required for accessibility)

On this page