Ordo UI
PatternsOverlays

ConfirmDialog

@mox-hub/patterns 模式 · Overlays · canonical

confirm-dialog@mox-hub/patternsOverlayscanonicalsrc/components/confirm-dialog.tsx

变体轴

tone
defaultdanger
变体演示confirm-dialog

Props API

Prop类型默认值说明
open*boolean——
onOpenChange*(open: boolean) => void——
title*ReactNode——
description*ReactNode——
confirmLabel*string——
cancelLabel*string——
tone*"danger" | "default"'default'—
onConfirm*() => void | Promise<void>——
busy*booleanfalse—
error*ReactNode——
labels*Partial<ConfirmDialogLabels>——

源码

packages/patterns/src/components/confirm-dialog.tsx
/**
 * ConfirmDialog - 危险/重要操作确认对话框(W4 B7:危险操作确认 + Promise 提交态)
 *
 * 用 ui/alert-dialog 承载 `alertdialog` 语义(标题/描述/取消/确认),并内聚
 * Promise 提交态:onConfirm 返回 Promise 时进入 submitting,等待期间取消/确认
 * 双钮禁用、Esc 与遮罩关闭请求被拦截;Promise resolve 后调用
 * `onOpenChange(false)` 自动关闭,reject 时保持打开(错误呈现由消费方经
 * error prop 注入,本件不吞掉除「保持打开」以外的处理,也不自行 toast)。
 *
 * 关闭策略(二选一裁决,本件选「resolve 自动关闭」):
 * - resolve → onOpenChange(false)(消费方仍可在受控 open 上拒绝关闭);
 * - reject → 保持打开,按钮恢复可点,等待消费方展示 error;
 * - busy 期间(内部 submitting 或外部 busy)→ 取消/确认禁用,Esc/遮罩不关闭。
 *
 * 分层:patterns 装配件,只组合 ui/alert-dialog 与 ui/button;不取数、不发请求、
 * 不持有业务错误状态,不依赖 router/query/i18n 框架。
 *
 * tone='danger' 时 AlertDialogAction 使用 Button 的 destructive 档(浅红底红字),
 * 与 §20.1 危险操作口径一致;默认档走主按钮。
 */
import { useState, type ReactNode } from 'react';
import {
  AlertDialog,
  AlertDialogAction,
  AlertDialogCancel,
  AlertDialogContent,
  AlertDialogDescription,
  AlertDialogFooter,
  AlertDialogHeader,
  AlertDialogTitle,
} from '@mox-hub/ui/components/alert-dialog';
import { Spinner } from '@mox-hub/ui/components/spinner';
import { usePatternLabels } from '../lib/i18n';

/** 组件内文案缺省(中文常量;消费方经 labels 覆写接入 i18n)。 */
export interface ConfirmDialogLabels {
  /** 确认按钮(confirmLabel prop 优先) */
  confirm: string;
  /** 取消按钮(cancelLabel prop 优先) */
  cancel: string;
  /** 提交中按钮文案 */
  busy: string;
}

export const CONFIRM_DIALOG_DEFAULT_LABELS: ConfirmDialogLabels = {
  confirm: '确认',
  cancel: '取消',
  busy: '处理中…',
};

export interface ConfirmDialogProps {
  open: boolean;
  onOpenChange: (open: boolean) => void;
  /** 对话框标题(必填,alertdialog 的无障碍名) */
  title: ReactNode;
  /** 说明文字(可选;不传时只保留标题语义) */
  description?: ReactNode;
  /** 确认按钮文案(优先于 labels.confirm) */
  confirmLabel?: string;
  /** 取消按钮文案(优先于 labels.cancel) */
  cancelLabel?: string;
  /** 确认按钮色调;danger 走 Button destructive 档 */
  tone?: 'default' | 'danger';
  /** 确认回调:返回 Promise 时进入提交态,resolve 后自动关闭 */
  onConfirm: () => void | Promise<void>;
  /** 外部提交中态(与内部 submitting 取或) */
  busy?: boolean;
  /** 服务端/业务错误呈现(role=alert,置于按钮区上方) */
  error?: ReactNode;
  /** 文案覆写(默认 zh-CN;主仓 i18n 适配层集中传入 t() 结果)。 */
  labels?: Partial<ConfirmDialogLabels>;
}

export function ConfirmDialog({
  open,
  onOpenChange,
  title,
  description,
  confirmLabel,
  cancelLabel,
  tone = 'default',
  onConfirm,
  busy: externalBusy = false,
  error,
  labels,
}: ConfirmDialogProps) {
  const D = usePatternLabels('confirmDialog', CONFIRM_DIALOG_DEFAULT_LABELS);
  const text: ConfirmDialogLabels = {
    confirm: confirmLabel ?? labels?.confirm ?? D.confirm,
    cancel: cancelLabel ?? labels?.cancel ?? D.cancel,
    busy: labels?.busy ?? D.busy,
  };
  const [submitting, setSubmitting] = useState(false);
  const busy = externalBusy || submitting;

  const handleConfirm = async () => {
    if (busy) return;
    setSubmitting(true);
    try {
      await onConfirm();
      // resolve:先落 submitting,再走原始 onOpenChange(绕过 busy 关闭守卫)
      setSubmitting(false);
      onOpenChange(false);
    } catch {
      // reject:保持打开,由消费方经 error prop 呈现错误;此处不重复抛错
      setSubmitting(false);
    }
  };

  // 关闭请求守卫:提交中 Esc/遮罩/取消一律不关闭;程序化关闭不经过此函数
  const handleOpenChange = (next: boolean) => {
    if (!next && busy) return;
    onOpenChange(next);
  };

  return (
    <AlertDialog open={open} onOpenChange={handleOpenChange}>
      <AlertDialogContent data-slot="confirm-dialog-content" data-tone={tone}>
        <AlertDialogHeader>
          <AlertDialogTitle>{title}</AlertDialogTitle>
          {description != null ? (
            <AlertDialogDescription>{description}</AlertDialogDescription>
          ) : null}
        </AlertDialogHeader>

        {error != null ? (
          <div
            data-slot="confirm-dialog-error"
            role="alert"
            className="rounded-md bg-destructive/10 px-3 py-2 text-sm text-destructive"
          >
            {error}
          </div>
        ) : null}

        <AlertDialogFooter>
          <AlertDialogCancel disabled={busy}>{text.cancel}</AlertDialogCancel>
          <AlertDialogAction
            variant={tone === 'danger' ? 'destructive' : 'default'}
            disabled={busy}
            aria-busy={busy || undefined}
            onClick={handleConfirm}
          >
            {busy ? <Spinner size="sm" className="size-3 text-inherit" aria-hidden="true" /> : null}
            {busy ? text.busy : text.confirm}
          </AlertDialogAction>
        </AlertDialogFooter>
      </AlertDialogContent>
    </AlertDialog>
  );
}

可访问性与 RTL

  • 键盘:交互件保留:focus-visible焦点环;浮层支持 Escape 关闭与焦点归还,菜单 / 页签按 Base UI 约定支持方向键。 筛选菜单、拖拽排序、执行树与模型 listbox 等关键键盘流由 Playwright 断言覆盖,见规范示例 · 交互与可访问性。
  • RTL:间距、对齐与方向性图标使用逻辑属性 (ms-* /text-start /rtl:-scale-x-100);通过 ThemeProvider 或I18nProvider 的direction="rtl"驱动,`lint:rtl` 会拦截新增物理类。
  • 文案:优先用组件labels /translate /translator props,其次用I18nProvider目录;内置 zh-CN 默认值,en-US 为参考翻译。见Theming · i18n 与 RTL。
  • 对比度:高对比度 token、2px 控件边框与 3px 焦点环由主题层统一提供,见Foundations · Contrast。

用法说明

危险操作确认框:标题/描述/确认/取消、tone=danger、onConfirm 返回 Promise 时双钮禁用;基于 ui/alert-dialog。