# @depay/react-dialog 中文文档

规范地址：https://npmcn.com/package/%40depay/react-dialog/

版本：14\.1\.1
npm 元数据更新时间：2024-01-22T16:33:44.442Z
中文译文更新时间：2026-11-12T03:33:47.647Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40depay/react-dialog
原文对照：https://npmcn.com/package/%40depay/react-dialog/?lang=original
项目主页：https://depay.com/
源码仓库：https://github.com/DePayFi/react-dialog

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：15.8 kB，5 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- Node.js 要求：\>=16
- 运行依赖：0 个
- peer 依赖：react ^18，react-dom ^18
- 首次发布：2021-11-26T18:40:14.051Z
- 最新版本发布：2023-07-14T10:00:00.454Z
- 近 30 天下载量：3075（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 0 个）

## 中文简介

反应的基本对话框组件 .

## 安装

```sh
npm install @depay/react-dialog
```

也可以使用：`pnpm add @depay/react-dialog`、`yarn add @depay/react-dialog`、`bun add @depay/react-dialog`

## README

## 快速启动

```
yarn add @depay/react-dialog
```

或者说

```
npm install --save @depay/react-dialog
```

```javascript
import { ReactDialog } from '@depay/react-dialog'

  /*...*/

  close() {
    if(this.state == something) {
      this.setState({ showDialog: false })
    }
  }

  /*...*/

  <ReactDialog close={this.close} open={this.state.showDialog}>
    <div className="ReactDialogAnimation MyDialogStyle">
      <h1>I am a dialog</h1>
      <button onclick={this.close}>Close Dialog</button>
    </div>
  </ReactDialog>
```

## 演示

[https://depayfi.github.io/react-dialog/demo.html 互联网档案馆的存檔,存档日期2014-12-22](https://depayfi.github.io/react-dialog/demo.html)

## 职能

### 渲染器

```javascript
import { ReactDialog } from '@depay/react-dialog'

render() {
  return(
    ...
    <ReactDialog close={this.close} open={this.state.showDialog}>
      <div className="ReactDialogAnimation MyDialogStyle">
        <h1>I am a dialog</h1>
        <button onclick={this.close}>Close Dialog</button>
      </div>
    </ReactDialog>
  )
}
```

请应用 `ReactDialogAnimation` 分类到您想要作为对话框打开动画的一部分被动画所显示的儿童元素.

#### 道具

`close (function)`: 从 ReactDialog 中调取的、在对话框中生活的函数 。 如果一个对话框是可阻塞的, 父母必须小心, 并且需要设定它自己的状态.

```javascript
  close() {
    if(this.state == something) {
      this.setState({ showDialog: false })
    }
  }

  /*...*/

  <ReactDialog close={this.close} open={this.state.showDialog}>
    <h1>I am a dialog</h1>
    <button onclick={this.close}>Close Dialog</button>
  </ReactDialog>
```

`background (string)`: 背景作为 CSS 传递到 `ReactDialogBackground`。 。 。 .

```javascript
  <ReactDialog background={'rgba(255,255,255,0.6)'} close={this.close} open={this.state.showDialog}>
    <h1>I am a dialog with white background.</h1>
  </ReactDialog>
```

`document (Document)`: 允许在对话框中转发不同的文档 .

```javascript

  <ReactDialog document={someIframe.document}>
    <h1>I am a dialog</h1>
    <button onclick={this.close}>Close Dialog</button>
  </ReactDialog>
```

`container (HTMLElement)`: 允许提供一个清晰的容器, 对话框应该被打开 .

```javascript

  <ReactDialog container={document.getElementById('app')}>
    <h1>I am a dialog</h1>
    <button onclick={this.close}>Close Dialog</button>
  </ReactDialog>
```

## 发展

### 开始吧

```
yarn install
yarn start
```

### 测试

#### 调试 Cypress

开始在 `--headed` 财务报告和审定财务报表 `--no-exit`

```
test:cypress:debug
```

测试并调试单个cypress文件 :

```
yarn test:cypress:debug --spec "cypress/integration/close.js"
```

### 释放

```
npm publish
```

## 常见问题

### @depay/react-dialog 是什么？

反应的基本对话框组件 \.

### 如何安装 @depay/react-dialog？

在项目目录运行 npm install @depay/react-dialog，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18）、react-dom（^18）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @depay/react-dialog 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/depay\_\_react-dialog 是否存在。

### @depay/react-dialog 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @depay/react-dialog 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=16。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @depay/react-dialog 可以商用吗？

@depay/react-dialog 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @depay/react-dialog 的下载量有多少？

根据 npm 官方下载统计，@depay/react-dialog 在 2026/10/12 – 2026/11/10 这 30 天内被下载 3,075 次，日均约 103 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @depay/react-dialog 还在维护吗？

最新版本 14\.1\.1 发布于 2023/07/14（3 年前）；至今共发布 14 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/11/27。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。