跳转到内容

公共 UI 组件与主题桥:CollapsibleTrigger – DialogSurfaceProps

本页由当前 SDK 声明自动生成。 导入入口:@woohaa3/ui。

返回接口索引

CollapsibleTrigger · ConfigIcon · CopyField · CopyIcon · CropIcon · CursorMenu · CursorMenuProps · Dialog · DialogBody · DialogContent · DialogContentProps · DialogDescription · DialogFooter · DialogHeader · DialogIconButton · DialogIconButtonProps · DialogMediaWorkspace · DialogSection · DialogSize · DialogStage · DialogSurface · DialogSurfaceContext · DialogSurfaceContextValue · DialogSurfaceProps

CollapsibleTrigger

export const CollapsibleTrigger: React.ForwardRefExoticComponent<Omit<CollapsiblePrimitive.CollapsibleTriggerProps & React.RefAttributes<HTMLButtonElement>, "ref"> & React.RefAttributes<HTMLButtonElement>>;

ConfigIcon

配置。

export const ConfigIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

CopyField

复制字段:成功/失败反馈,注入 adapter(Showcase 不触碰真实 clipboard)。

export function CopyField({ value, label, copyText, className, children }: { value: string; label: string; copyText: (value: string) => Promise<boolean | void>; className?: string; children?: ReactNode; }): React.JSX.Element;

CopyIcon

export const CopyIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

CropIcon

export const CropIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

CursorMenu

Canvas cursor anchor 菜单。

用 Radix DropdownMenu + 固定零尺寸锚点承载:Radix 负责碰撞/flip/边距与完整菜单键盘 语义(方向键、Home/End、Enter/Space、Escape、typeahead、单次 select),宿主负责 menu route;不再依赖手工 viewport 翻转或 window keydown/pointerdown listener。

export function CursorMenu(props: CursorMenuProps): React.JSX.Element;

关联类型:CursorMenuProps

CursorMenuProps

export type CursorMenuProps = {
open: boolean;
onOpenChange: (open: boolean) => void;
x: number;
y: number;
items: readonly MenuItem[];
label?: string;
className?: string;
itemClassName?: string;
separatorClassName?: string;
};

关联类型:MenuItem

成员说明:

  • open:是否打开(受控:Navigation/宿主是 menu route owner)。
  • x:屏幕坐标(clientX/clientY)。
  • label:菜单可访问名(例如「插入节点」)。
  • className:content 追加 class(迁移期保留业务定位 class)。
  • itemClassName:菜单项追加 class(迁移期保留业务 selector)。
  • separatorClassName:分隔线追加 class(迁移期保留业务 selector)。

Dialog

组合导出(design D1:Dialog.Root/Content/Header/…)。

export const Dialog: { Content: (props: DialogContentProps) => React.JSX.Element; Header: (props: { children: ReactNode; onClose?: () => void; closeLabel?: string; }) => React.JSX.Element; Title: (props: { id?: string; children: ReactNode; }) => React.JSX.Element; Description: (props: { id?: string; children: ReactNode; }) => React.JSX.Element; Body: (props: { children: ReactNode; className?: string; }) => React.JSX.Element; Toolbar: (props: { children: ReactNode; className?: string; label?: string; }) => React.JSX.Element; Section: (props: { children: ReactNode; className?: string; }) => React.JSX.Element; Footer: (props: { children: ReactNode; className?: string; }) => React.JSX.Element; MediaWorkspace: (props: { children: ReactNode; aside?: ReactNode; className?: string; }) => React.JSX.Element; Stage: (props: { children: ReactNode; className?: string; label?: string; }) => React.JSX.Element; IconButton: (props: DialogIconButtonProps) => React.JSX.Element; };

关联类型:DialogContentProps · IconButton · DialogIconButtonProps

DialogBody

独立滚动的正文区。

export function DialogBody(props: { children: ReactNode; className?: string; }): React.JSX.Element;

DialogContent

单个弹窗内容容器。

强制可访问名:必须提供 ariaLabel 或 labelledBy,否则抛错(design:无名称弹窗不可发布)。 命中 Dialog Host context 时使用 Radix DialogSurface(modal/focus/dismiss);脱离 Host (Showcase/单测静态渲染)时退化为既有 markup。

export function DialogContent(props: DialogContentProps): React.JSX.Element;

关联类型:DialogContentProps

DialogContentProps

export type DialogContentProps = {
variant?: DialogVariant;
size?: DialogSize;
className?: string;
labelledBy?: string;
describedBy?: string;
ariaLabel?: string;
busy?: boolean;
onOverlayClick?: () => void;
instanceId?: string;
children: ReactNode;
};

关联类型:DialogVariant · DialogSize

成员说明:

  • className:业务表面追加布局类,不改变弹窗状态。
  • labelledBy:可访问名称来源:aria-labelledby 指向的 Title 元素 id。
  • describedBy:可访问描述来源:aria-describedby 指向的 Description 元素 id。
  • ariaLabel:无 Title 时的兜底可访问名(二者至少一个)。
  • busy:busy:aria-busy 且禁止隐式关闭(由 Host/调用方配合)。
  • onOverlayClick:点击遮罩的回调(是否可关闭由 Host 的 close policy 决定)。
  • instanceId:测试/定位用实例标识。

DialogDescription

可访问描述(补充说明)。

export function DialogDescription(props: { id?: string; children: ReactNode; }): React.JSX.Element;

DialogFooter

Footer:固定操作区。

export function DialogFooter(props: { children: ReactNode; className?: string; }): React.JSX.Element;

DialogHeader

Header:标题行 + 可选关闭按钮(图标语言,不再是 ✕ 字符)。

export function DialogHeader(props: { children: ReactNode; onClose?: () => void; closeLabel?: string; }): React.JSX.Element;

DialogIconButton

紧凑图标按钮(共享 neutral/icon variant)。

统一 focus ring、禁用态与命中尺寸;业务弹窗不得再用字体字符实现关闭/缩放/播放/移除控件

这里保留原生 title 作为可见提示而不包共享 Tooltip:弹窗打开时会 autofocus 首个可聚焦 控件(通常是关闭按钮),若该控件触发 Radix Tooltip,其 dismissable layer 会成为最高层并 抢占 Escape。关闭/缩放这类熟悉操作的名称已由 label 表达,无需额外 popup tooltip。

export function DialogIconButton(props: DialogIconButtonProps): React.JSX.Element;

关联类型:DialogIconButtonProps

DialogIconButtonProps

export type DialogIconButtonProps = {
label: string;
tooltip?: string;
icon: ReactNode;
onClick: () => void;
disabled?: boolean;
pressed?: boolean;
className?: string;
testId?: string;
};

成员说明:

  • label:可访问名称(必填:icon-only 按钮必须有名称)。
  • tooltip:非显而易见操作的补充提示。
  • pressed:切换类操作的按下态(如静音、选帧)。
  • testId:测试/定位用标识。

DialogMediaWorkspace

共享媒体工作区 composition。

桌面为稳定的主媒体区 + 可选辅助区;窄屏降为单列。只负责结构与框高,不提升业务 state、 不读写媒体 intrinsic size,因此 Content 外框不随素材比例跳动。

export function DialogMediaWorkspace(props: { children: ReactNode; aside?: ReactNode; className?: string; }): React.JSX.Element;

DialogSection

分区标题/内容。

export function DialogSection(props: { children: ReactNode; className?: string; }): React.JSX.Element;

DialogSize

export type DialogSize = "sm" | "md" | "lg" | "fullscreen";

DialogStage

媒体舞台:中性高对比 surface 上按 contain 呈现图片/视频,自身裁切平移/缩放。 label 提供可访问组名;媒体 token 只允许出现在此舞台与其叠层内(design D1)。

export function DialogStage(props: { children: ReactNode; className?: string; label?: string; }): React.JSX.Element;

DialogSurface

单个弹窗 surface。

结构稳定是硬约束: 嵌套确认打开后父层从 top 退化为非 top;Radix Root 的 modal 变化会重挂内容,父弹窗的 草稿与滚动随之丢失。因此 Host 内始终渲染同一个 Radix Content(forceMount 保证父层 也留在 DOM),只由 aria-modal、遮罩点击与 dismiss 判定表达「是否为当前活动层」。

export function DialogSurface(props: DialogSurfaceProps): React.JSX.Element;

关联类型:DialogSurfaceProps

DialogSurfaceContext

export const DialogSurfaceContext: React.Context<DialogSurfaceContextValue | null>;

关联类型:Context · DialogSurfaceContextValue

DialogSurfaceContextValue

export type DialogSurfaceContextValue = {
modal: boolean;
dismissible: boolean;
busy: boolean;
requestClose: () => void;
onOpenAutoFocus?: (event: Event) => void;
onCloseAutoFocus?: (event: Event) => void;
};

成员说明:

  • requestClose:向 Host 发出一次 close request(是否真正关闭由 Host policy 决定)。
  • onOpenAutoFocus:打开时把焦点移入(Host 按既有 initial-target 顺序)。
  • onCloseAutoFocus:关闭后恢复焦点(Host 按 opener map / 画布 owner)。

DialogSurfaceProps

export type DialogSurfaceProps = {
ariaLabel?: string;
labelledBy?: string;
describedBy?: string;
className?: string;
overlayClassName?: string;
instanceId?: string;
busy?: boolean;
onOverlayClick?: () => void;
children: ReactNode;
};

成员说明:

  • ariaLabel:可访问名称来源(至少 ariaLabel/labelledBy 之一,由上层校验)。
  • className:Content(.dlg)class。
  • overlayClassName:Overlay class(缺省 .dlg__overlay)。
  • instanceId:测试/定位用实例标识。
  • busy:busy:aria-busy 且禁止隐式关闭。
  • onOverlayClick:standalone(无 Host)时点击遮罩的 close 回调。