# @berlitz/newsletter-sign-up 中文文档

规范地址：https://npmcn.com/package/%40berlitz/newsletter-sign-up/

版本：4\.4\.5
npm 元数据更新时间：2026-11-05T19:18:53.956Z
中文译文更新时间：2026-11-07T23:07:19.579Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：66.8 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：8 个
- peer 依赖：axios 0\.19\.2，react 16\.13\.1，styled-components 5\.2\.3
- 首次发布：2018-12-07T00:10:05.626Z
- 最新版本发布：2026-05-26T07:33:44.011Z
- 近 30 天下载量：2089（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：293（近 12 个月 2 个）

## 中文简介

Max 设计系统通讯签名组件

## 安装

```sh
npm install @berlitz/newsletter-sign-up
```

也可以使用：`pnpm add @berlitz/newsletter-sign-up`、`yarn add @berlitz/newsletter-sign-up`、`bun add @berlitz/newsletter-sign-up`

## README

# 通讯签名 [![npm version](https://img.shields.io/npm/v/@berlitz/newsletter-sign-up.svg)](https://www.npmjs.com/package/@berlitz/newsletter-sign-up)

已设计了通讯注册部分,以便在页脚上添加自定义字段供订阅通讯。 您可以通过 `fields` 组件生成到 html 的道具组成字段. 字段类型可以选择,复选框和文本.

## 安装

```shell
yarn add @berlitz/newsletter-sign-up
```

## 道具

| 参数 | 类型 | 需求 | 默认 | 示例 |
| --- | --- | --- | --- | --- |
| 结束点Url | 字符串 | ❌ |  |  |
| 错误文本 | 字符串 | ❌ | '有错误报名! 请重新刷新并尝试。" |  |
| 字段 | 数组 | ❌ | \[ |  |
| 获取端点Url | 函数 | ❌ |  |  |
| 隐藏字段 | 数组 | ❌ | \[ |  |
| 地图格式Values To PostBody | 函数 | ❌ |  |  |
| 注解文本 | 字符串 | ❌ |  |  |
| 提交文本 | 字符串 | ❌ | 签名, |  |
| 提交日期 文本 | 字符串 | ❌ | '臣服' "服从" |  |
| 成功文本 | 字符串 | ❌ | "谢谢你的报名!" |  |
| 标题 | 字符串 | ✅ |  |  |
| 取消订阅文本 | 字符串 | ❌ |  |  |

## 使用量

```jsx
import NewsletterSignUp from '@berlitz/newsletter-sign-up'
const MyApp = () => <NewsletterSignUp
  endpointUrl="//signup.example.com"
  title="Sign up for newsletter"
  fields={[
    { name: "name", type: "text", label: "Your name" },
    { name: "email", type: "email", label: "Your email" }
  ]}
  />
```

### 何时使用此组件

传过来 [页脚](https://npmcn.com/?path=/story/components-footer--default)是因为 `newsletterComponent` 作为节点的道具.

### 页:1

静态 `endpointUrl` 可覆盖 `getEndpointUrl` 函数生成 url 从 `values` 形式。 数据正在输入 `application/json` 格式。 寄出的对象可以重映射通过 `mapFormValuesToPostBody` 函数.

## 常见问题

### @berlitz/newsletter-sign-up 是什么？

Max 设计系统通讯签名组件

### 如何安装 @berlitz/newsletter-sign-up？

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

### @berlitz/newsletter-sign-up 支持 TypeScript 吗？

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

### @berlitz/newsletter-sign-up 支持 ESM 还是 CommonJS？

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

### @berlitz/newsletter-sign-up 可以商用吗？

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

### @berlitz/newsletter-sign-up 的下载量有多少？

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

### @berlitz/newsletter-sign-up 还在维护吗？

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