JGuang

对话框

Dialog · Chakra UI

交互预览
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

对话框

用于需要用户关注的模态流程。提供标题和明确退出方式,设置合理的初始焦点并验证焦点约束;关闭后返回触发器,嵌套弹层沿用原生定位与 Portal 组合。

随附图标许可

源码查看器包含 ICON_ATTRIBUTION.md,以及本组示例实际使用的图标集合原始许可。再分发示例时请保留;react-icons 封装包的许可证不能替代各图标集合自身的条款。

  • Lucide: ISC

安装与初始化

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

渲染前配置 ChakraProvider、defaultSystem 和 Emotion。保留宿主项目的 React 版本并检查 peer 兼容。官方 npm 安装提供组件包,不会复制以下示例源码。locale、next-themes 和框架专属 SSR 配置见资源安装指南;npm 安装之外还需单独复制所选示例源码。

完整原生使用示例

这是固定版本的真实示例,不是通用 API 伪代码。复制完整源码依赖并保留命名导出;附加依赖逐例列在下方。

import { Button, CloseButton, Dialog, Portal } from "@chakra-ui/react"

export const DialogBasic = () => {
  return (
    <Dialog.Root>
      <Dialog.Trigger asChild>
        <Button variant="outline" size="sm">
          Open Dialog
        </Button>
      </Dialog.Trigger>
      <Portal>
        <Dialog.Backdrop />
        <Dialog.Positioner>
          <Dialog.Content>
            <Dialog.Header>
              <Dialog.Title>Dialog Title</Dialog.Title>
            </Dialog.Header>
            <Dialog.Body>
              <p>
                Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do
                eiusmod tempor incididunt ut labore et dolore magna aliqua.
              </p>
            </Dialog.Body>
            <Dialog.Footer>
              <Dialog.ActionTrigger asChild>
                <Button variant="outline">Cancel</Button>
              </Dialog.ActionTrigger>
              <Button>Save</Button>
            </Dialog.Footer>
            <Dialog.CloseTrigger asChild>
              <CloseButton size="sm" />
            </Dialog.CloseTrigger>
          </Dialog.Content>
        </Dialog.Positioner>
      </Portal>
    </Dialog.Root>
  )
}

全部示例与复现要求

示例名称用于选择演示,不是组件通用 variant 属性。复制所选示例全部 sourceFiles;compositions 别名表示本地文件,不是 npm 包。保留相对导入或映射到宿主真实目录。React peer 单独检查;编辑器示例保留一致的固定 Tiptap 扩展版本。

基础用法

dialog-basic · 命名导出 DialogBasic · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-basic.tsx

不同尺寸

dialog-with-sizes · 命名导出 DialogWithSizes · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-with-sizes.tsx

覆盖

dialog-with-cover · 命名导出 DialogWithCover · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-with-cover.tsx

全屏

dialog-with-fullscreen · 命名导出 DialogWithFullscreen · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-with-fullscreen.tsx

响应式尺寸

dialog-with-responsive-size · 命名导出 DialogWithResponsiveSize · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-with-responsive-size.tsx

位置

dialog-with-placement · 命名导出 DialogWithPlacement · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-with-placement.tsx

受控状态

dialog-controlled · 命名导出 DialogControlled · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 prop-types@15.8.1 react-lorem-ipsum@1.4.10
  • vendor/apps/compositions/src/examples/dialog-controlled.tsx

多个触发器

dialog-with-multiple-triggers · 命名导出 DialogWithMultipleTriggers · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-with-multiple-triggers.tsx

外部状态仓库

dialog-with-store · 命名导出 DialogWithStore · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-with-store.tsx

上下文

dialog-with-context · 命名导出 DialogWithContext · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-with-context.tsx

嵌套

dialog-nested · 命名导出 DialogNested · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 prop-types@15.8.1 react-lorem-ipsum@1.4.10
  • vendor/apps/compositions/src/examples/dialog-nested.tsx

打开来源弹出层

dialog-open-from-popover · 命名导出 DialogOpenFromPopover · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-open-from-popover.tsx

打开来源菜单

dialog-open-from-menu · 命名导出 DialogOpenFromMenu · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 react-icons@5.6.0
  • vendor/apps/compositions/src/examples/dialog-open-from-menu.tsx

初始焦点

dialog-with-initial-focus · 命名导出 DialogWithInitialFocus · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-with-initial-focus.tsx

内部滚动

dialog-with-inside-scroll · 命名导出 DialogWithInsideScroll · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 prop-types@15.8.1 react-lorem-ipsum@1.4.10
  • vendor/apps/compositions/src/examples/dialog-with-inside-scroll.tsx

外部滚动

dialog-with-outside-scroll · 命名导出 DialogWithOutsideScroll · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 prop-types@15.8.1 react-lorem-ipsum@1.4.10
  • vendor/apps/compositions/src/examples/dialog-with-outside-scroll.tsx

动效预设

dialog-with-motion-preset · 命名导出 DialogWithMotionPreset · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-with-motion-preset.tsx

角色

dialog-with-role · 命名导出 DialogWithRole · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-with-role.tsx

关闭外部

dialog-with-close-outside · 命名导出 DialogWithCloseOutside · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-with-close-outside.tsx

非模态

dialog-non-modal · 命名导出 DialogNonModal · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-non-modal.tsx

描述列表

dialog-with-datalist · 命名导出 DialogWithDatalist · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/dialog-with-datalist.tsx

原生 API 与源码参考

源码查看器保留原始声明、import 与继承关系。Ark UI 事件契约、Chakra 样式属性和 recipe 类型仍以原生包为准;本指南不平铺或编造默认值。代码注释保留原文,不冒充正文翻译。

  • npm/@chakra-ui/react@3.37.0/dist/types/components/dialog/dialog.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/dialog/index.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/dialog/namespace.d.ts

Vite 8 定向导出兼容

本组部分示例导入 react-lorem-ipsum@1.4.10。已验证的 Vite 8 消费项目在 plugins 中使用随附 authored/native-package-interop.mjs 的 chakraNativePackageInterop(process.cwd())。将该辅助模块放入宿主构建配置并调整导入路径。它只解包原生 CommonJS 默认导出,不替换组件实现;仅在复现相同导出差异时使用,其他构建器可能不需要。

状态与安装后检查

执行严格类型检查、目标项目生产构建和实际操作。检查名称/焦点/键盘、深浅色、窄屏、原生支持的空/加载/错误状态以及卸载清理。预览限制远程接口、上传与下载,业务服务需自行配置。复制命令或预览就绪不代表安装完成或后端成功。

来源与许可边界

https://github.com/chakra-ui/chakra-ui/tree/2e7517745cff2fcde0b8012f136cf99611ff262a

本页是 JGuang 双语实用说明,不声称全文翻译上游 MDX。原始文档与示例字节保留在 vendor。保留仓库 MIT、compositions 的 ISC 元数据和独立依赖声明;原始许可元数据差异与缺失完整声明仍作为显式审查事项,不包含 Chakra Pro 付费内容。