pdfcn README

The project's README from github.com/shadcn-labs/pdfcn. As one markdown file: README.md.

pdfcn banner

pdfcn

Free & open-source, ready-to-use, customizable PDF components for React.
Copy, paste, and ship. Built on Takumi and Forme, works seamlessly with shadcn/ui.

GitHub Stars CI Discord Members X Follow

Get Started · Installation · Components · Blocks

Features

Community

The pdfcn community lives on GitHub, where you can ask questions, share ideas, and show what you've built.

Contributing

Contributions are welcome. See CONTRIBUTING.md to get the repo running locally and land a change, and use issues and discussions to collaborate. By participating, you agree to the Code of Conduct.

Security

Please do not open public issues for security vulnerabilities. Follow SECURITY.md and report them privately through GitHub Security Advisories.

License

MIT

Contributors

Contributors

Made with contrib.rocks

Sponsors

This project is proudly supported by:

Gold sponsors
React Bits Pro

Found this project useful? Sponsor us to help with support and maintenance.

Stats

Stats

Star History

Star History Chart

pdfcn (shadcn-labs/pdfcn)

Searching Database…

2.9K ·GitHub
What is this?pdfcn is a free, open-source collection of ready-to-use, customizable PDF components for React that you copy into your project and ship, rather than install as a dependency.
Is this a library I import, or a shadcn-style set of components I copy in?It works like shadcn/ui: you copy component source into your own codebase using the same registry format and CLI workflow, so you own and can edit the generated code directly.
How do I add pdfcn components to my React project?You pull individual components and blocks — tables, forms, charts, invoices, reports and more — from pdfcn's registry using the shadcn/ui-compatible CLI workflow.
Do I need to set up Takumi or Forme separately?No, each component just renders its PDF through one of two built-in rendering engines, Takumi or Forme, and you pick which one a given component uses.
Does it come preconfigured, or do I need to tweak a lot before it works?It's zero-config and works out of the box with sensible defaults, while still exposing props and shared themes if you want to customize further.
What are Takumi and Forme?They are the two separate PDF rendering engines pdfcn is built on top of, and each component lets you choose which one generates its output.
Can I preview components before using them?Yes, every component and block has a live preview rendered directly in the documentation, so you can see the output before copying it in.
Can I restyle the generated PDFs, like invoices or reports?Yes, components ship with sensible props and shared themes, and since the code is copied into your project you fully own and can modify it.
Does using pdfcn require learning a new component API?Not really — it's composable from focused React components and renderer primitives, so you build documents the same way you'd build normal React UI.
Size
5 MB
Stars
2.9K
Updated
CommitOct 15
Age
2mo
Commits · 90 Days