# @berlitz/modal 中文文档

规范地址：https://npmcn.com/package/%40berlitz/modal/

版本：4\.2\.0
npm 元数据更新时间：2026-11-05T19:18:40.467Z
中文译文更新时间：2026-11-08T03:12:20.721Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40berlitz/modal
原文对照：https://npmcn.com/package/%40berlitz/modal/?lang=original
项目主页：https://github.com/berlitz-global/max/blob/master/components/modal/CHANGELOG.md

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

- 包体积（解压后）：24.8 kB，6 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- peer 依赖：react 16\.13\.1，polished ^3\.4\.1，styled-components 5\.2\.3
- 首次发布：2018-10-22T11:18:02.027Z
- 最新版本发布：2024-10-17T02:26:37.603Z
- 近 30 天下载量：1922（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：152（近 12 个月 0 个）

## 中文简介

Max 设计系统的模块组件

## 安装

```sh
npm install @berlitz/modal
```

也可以使用：`pnpm add @berlitz/modal`、`yarn add @berlitz/modal`、`bun add @berlitz/modal`

## README

# 模式 [![npm version](https://img.shields.io/npm/v/@berlitz/modal.svg)](https://www.npmjs.com/package/@berlitz/modal)

## 安装

```shell
yarn add @berlitz/modal
```

## 道具

| 参数 | 类型 | 需求 | 默认 | 说明 |
| --- | --- | --- | --- | --- |
| 儿童 | 节点 | ✅ | \- 说吧 | 曾以内容填充模式内部. |
| 关闭 | 函数 | ✅ | \- 说吧 | 点击关闭按钮时调用回调功能,用户在模式外点击或按下"逃避"键. |
| 打开 | 布尔 | ❌ | `false` | 打开或关闭模式. |
| 大小 | 字符串 | ❌ | 静态 | 设置模式的大小. |

## 使用量

```jsx
// TODO fill this in
import Modal from '@berlitz/modal'

export class App extends React.Component {
  state = {
    open: this.props.open || false,
  }

  render() {
    return (
      <>
        <Modal
          size="md"
          open={this.state.open}
          onClose={() => this.setState({ open: false })}
        >
          <h1>All of my modal content goes here</h1>
        </Modal>
        <Button onClick={() => this.setState({ open: true })}>
          Open Modal
        </Button>
      </>
    )
  }
}
```

## 常见问题

### @berlitz/modal 是什么？

Max 设计系统的模块组件

### 如何安装 @berlitz/modal？

在项目目录运行 npm install @berlitz/modal，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（16\.13\.1）、polished（^3\.4\.1）、styled-components（5\.2\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @berlitz/modal 支持 TypeScript 吗？

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

### @berlitz/modal 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @berlitz/modal 可以商用吗？

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

### @berlitz/modal 的下载量有多少？

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

### @berlitz/modal 还在维护吗？

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