# @alexandernanberg/react-pdf-renderer 中文文档

规范地址：https://npmcn.com/package/%40alexandernanberg/react-pdf-renderer/

版本：4\.0\.0-canary-5
npm 元数据更新时间：2024-11-15T07:36:50.873Z
中文译文更新时间：2026-11-05T20:24:51.314Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40alexandernanberg/react-pdf-renderer
原文对照：https://npmcn.com/package/%40alexandernanberg/react-pdf-renderer/?lang=original
项目主页：https://github.com/diegomura/react-pdf#readme
源码仓库：https://github.com/diegomura/react-pdf

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

- 包体积（解压后）：6.4 MB，17 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：10 个
- peer 依赖：react ^19\.0\.0
- 首次发布：2024-06-12T14:17:09.658Z
- 最新版本发布：2024-11-15T07:36:50.692Z
- 近 30 天下载量：28502（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

在浏览器和服务器上创建 PDF 文件

## 安装

```sh
npm install @alexandernanberg/react-pdf-renderer
```

也可以使用：`pnpm add @alexandernanberg/react-pdf-renderer`、`yarn add @alexandernanberg/react-pdf-renderer`、`bun add @alexandernanberg/react-pdf-renderer`

## README

![](https://user-images.githubusercontent.com/5600341/27505816-c8bc37aa-587f-11e7-9a86-08a2d081a8b9.png)

在浏览器和服务器上创建 PDF 文件的反应渲染器

 [![](https://img.shields.io/npm/v/@react-pdf/renderer.svg)](https://www.npmjs.com/package/@react-pdf/renderer)[![](https://img.shields.io/travis/diegomura/react-pdf.svg) ](https://travis-ci.org/diegomura/react-pdf)[![](https://img.shields.io/github/license/diegomura/react-pdf.svg) ](https://github.com/diegomura/react-pdf/blob/master/LICENSE)[![](https://withspectrum.github.io/badge/badge.svg) ](https://spectrum.chat/react-pdf)[![](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

## 如何安装

```sh
yarn add @react-pdf/renderer
```

## 如何运作

```jsx
import { Document, Page, Text, View, StyleSheet } from '@react-pdf/renderer';

// Create styles
const styles = StyleSheet.create({
  page: {
    flexDirection: 'row',
    backgroundColor: '#E4E4E4',
  },
  section: {
    margin: 10,
    padding: 10,
    flexGrow: 1,
  },
});

// Create Document Component
const MyDocument = () => (
  <Document>
    <Page size="A4" style={styles.page}>
      <View style={styles.section}>
        <Text>Section #1</Text>
      </View>
      <View style={styles.section}>
        <Text>Section #2</Text>
      </View>
    </Page>
  </Document>
);
```

### `Web.` 在DOM中渲染

```jsx
import ReactDOM from 'react-dom';
import { PDFViewer } from '@react-pdf/renderer';

const App = () => (
  <PDFViewer>
    <MyDocument />
  </PDFViewer>
);

ReactDOM.render(<App />, document.getElementById('root'));
```

### `Node.` 在文件中保存

```jsx
import ReactPDF from '@react-pdf/renderer';

ReactPDF.render(<MyDocument />, `${__dirname}/example.pdf`);
```

## 实例

尝试打开 `output.pdf` 看结果.

<table><tbody><tr><td align="center"><a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/text/" rel="nofollow noopener noreferrer"><img height="150" src="https://github.com/diegomura/react-pdf/blob/master/packages/examples/src/text/thumb.png?raw=true" width="150" loading="lazy" decoding="async" referrerpolicy="no-referrer"></a><br><a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/text/" rel="nofollow noopener noreferrer">文本</a></td><td align="center"><a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/resume/" rel="nofollow noopener noreferrer"><img height="150" src="https://github.com/diegomura/react-pdf/blob/master/packages/examples/src/resume/thumb.png?raw=true" width="150" loading="lazy" decoding="async" referrerpolicy="no-referrer"></a><br><a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/resume/" rel="nofollow noopener noreferrer">继续</a></td><td align="center"><a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/fractals/" rel="nofollow noopener noreferrer"><img height="150" src="https://github.com/diegomura/react-pdf/blob/master/packages/examples/src/fractals/thumb.png?raw=true" width="150" loading="lazy" decoding="async" referrerpolicy="no-referrer"></a><br><a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/fractals/" rel="nofollow noopener noreferrer">分块</a></td></tr></tbody></table>

<table><tbody><tr><td align="center"><a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/knobs/" rel="nofollow noopener noreferrer"><img height="150" src="https://github.com/diegomura/react-pdf/blob/master/packages/examples/src/knobs/thumb.png?raw=true" width="150" loading="lazy" decoding="async" referrerpolicy="no-referrer"></a><br><a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/knobs/" rel="nofollow noopener noreferrer">节点</a></td><td align="center"><a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/pageWrap/" rel="nofollow noopener noreferrer"><img height="150" src="https://github.com/diegomura/react-pdf/blob/master/packages/examples/src/pageWrap/thumb.png?raw=true" width="150" loading="lazy" decoding="async" referrerpolicy="no-referrer"></a><br><a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/pageWrap/" rel="nofollow noopener noreferrer">页面包装</a></td></tr></tbody></table>

## 贡献者

这个项目的存在要归功于所有作出贡献的人. [\[贡献\]](https://npmcn.com/package/%40alexandernanberg/react-pdf-renderer/CONTRIBUTING.md)。 。 。 . [![](https://opencollective.com/react-pdf/contributors.svg?width=890)](https://github.com/diegomura/react-pdf/graphs/contributors)

## 发起人

感谢所有赞助商[成为提案国](https://opencollective.com/react-pdf#sponsors)\[ . \]

[![](https://opencollective.com/react-pdf/sponsors.svg?width=890)](https://opencollective.com/react-pdf#sponsors)

## 备份

谢谢你所有的支持者[成为后卫](https://opencollective.com/react-pdf#backer)\[ . \]

[![](https://opencollective.com/react-pdf/backers.svg?width=890)](https://opencollective.com/react-pdf#backers)

## 许可证

麻省理工学院 [迭戈·穆拉乔勒](http://github.com/diegomura)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftaylorudell%2Freact-pdf.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftaylorudell%2Freact-pdf?ref=badge_large)

* * *

![](https://img.shields.io/npm/dt/@react-pdf/renderer.svg?style=flat)

## 常见问题

### @alexandernanberg/react-pdf-renderer 是什么？

在浏览器和服务器上创建 PDF 文件

### 如何安装 @alexandernanberg/react-pdf-renderer？

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

### @alexandernanberg/react-pdf-renderer 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @alexandernanberg/react-pdf-renderer 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @alexandernanberg/react-pdf-renderer 可以商用吗？

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

### @alexandernanberg/react-pdf-renderer 的下载量有多少？

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

### @alexandernanberg/react-pdf-renderer 还在维护吗？

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

