@alexandernanberg/react-pdf-renderer

中文文档
4.0.0-canary-5发布于 2024/11/15MITTypeScriptES Module近 30 天下载 2.9万

Create PDF files on the browser and server

原始使用文档
文档目录9 节
  1. How to install
  2. How it works
  3. Web. Render in DOM
  4. Node. Save in a file
  5. Examples
  6. Contributors
  7. Sponsors
  8. Backers
  9. License

React renderer for creating PDF files on the browser and server

How to install

yarn add @react-pdf/renderer

How it works

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. Render in DOM

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

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

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

Node. Save in a file

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

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

Examples

For each example, try opening output.pdf to see the result.


Text

Resume

Fractals

Knobs

Page wrap

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Sponsors

Thank you to all our sponsors! [Become a sponsors]

Backers

Thank you to all our backers! [Become a backer]

License

MIT © Diego Muracciole

FOSSA Status


版本与发布记录

@alexandernanberg/react-pdf-renderer 共发布 6 个版本,首次发布于 2024/06/12;过去 12 个月发布了 0 个版本。

版本发布日期距今
4.0.0-canary-5latest2024/11/152 年前
4.0.0-canary-42024/11/012 年前
4.0.0-canary-32024/10/232 年前
4.0.0-canary-22024/06/132 年前
4.0.0-canary-12024/06/132 年前
4.0.0-canary2024/06/122 年前

关于 @alexandernanberg/react-pdf-renderer 的常见问题

@alexandernanberg/react-pdf-renderer 是什么?

Create PDF files on the browser and server

如何安装 @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 和提交记录判断。