# @freshworks/modal 中文文档

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

版本：0\.18\.1
npm 元数据更新时间：2026-07-09T05:28:16.592Z
中文译文更新时间：2026-11-15T17:01:51.378Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40freshworks/modal
原文对照：https://npmcn.com/package/%40freshworks/modal/?lang=original
项目主页：https://freshdesk.github.io/nucleus
源码仓库：https://github.com/freshdesk/nucleus

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

- 包体积（解压后）：4.9 MB，178 个文件
- TypeScript 类型：未声明
- Node.js 要求：8\.\* \|\| \>= 10\.\*
- 运行依赖：11 个
- 首次发布：2019-11-07T13:09:43.221Z
- 最新版本发布：2023-09-20T06:19:21.574Z
- 近 30 天下载量：2121（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：43（近 12 个月 0 个）

## 中文简介

核心中的模块组件

## 安装

```sh
npm install @freshworks/modal
```

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

## README

# @ 新鲜工作/ 模式

[![npm version](https://badge.fury.io/js/%40freshworks%2Fmodal.svg)](https://www.npmjs.com/package/@freshworks/modal) ![npm](https://img.shields.io/npm/dm/@freshworks/modal)

```
ember install @freshworks/modal
```

Modals是一个交互组件,出现在页面上方,停止了背后的任何其他交互. 它有一个重点突出的任务,其内部很少像CTA这样的组成部分. Modals要求用户对它作出批判性的反应,以便回到首要任务.

## 假设

模式的最佳用途是迅速完成任务,并可能支持完成主要任务,例如: 创建实体并对其进行编辑。 Modal必须具有相关性并仔细加以利用,以吸引用户的注意,并可能阻碍他们目前的流动.

## 准则

**医生**

1.  在正文中添加卷轴( CTA 保留固定), 以防内容更多 .
2.  标题的图标必须是上下文
3.  重点应放在打开时的第一个模式项目上

**国家**

1.  不要超过800 px的最大宽度
2.  避免在模式上使用2级模式.
3.  如果与用户当前的任务流量无关, 请不要使用模式 .
4.  避免采取需要额外信息来源的复杂决策模式.
5.  避免在外部点击时关闭确认模式并形成需要用户确认或输入的对话框.

## 常见问题

### @freshworks/modal 是什么？

核心中的模块组件

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

在项目目录运行 npm install @freshworks/modal，或使用 pnpm add / yarn add / bun add。

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

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

### @freshworks/modal 需要什么版本的 Node\.js？

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

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

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

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

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

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

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