Simple primitives to compose powerful PDF viewing experiences.
powered by PDF.js and React
# `lector`
A composable, headless PDF viewer toolkit for React applications, powered by `PDF.js`. Build feature-rich PDF viewing experiences with full control over the UI and functionality.
[](https://www.npmjs.com/package/@letter-ai/lector)
[](https://opensource.org/licenses/MIT)
## Installation
```bash
npm install @letter-ai/lector pdfjs-dist
# or with yarn
yarn add @letter-ai/lector pdfjs-dist
# or with pnpm
pnpm add @letter-ai/lector pdfjs-dist
```
## Basic Usage
Here's a simple example of how to create a basic PDF viewer:
```tsx
import { CanvasLayer, Page, Pages, Root, TextLayer } from "@letter-ai/lector";
import "pdfjs-dist/web/pdf_viewer.css";
export default function PDFViewer() {
return (
Loading...}
>
);
}
```
## Features
- 📱 Responsive and mobile-friendly
- 🎨 Fully customizable UI components
- 🔍 Text selection and search functionality
- 📑 Page thumbnails and outline navigation
- 🌗 First-class dark mode support
- 🖱️ Pan and zoom controls
- 📝 Form filling support
- 🔗 Internal and external link handling
## Contributing
We welcome contributions! Key areas we're focusing on:
1. Performance optimizations
2. Accessibility improvements
3. Mobile/touch interactions
4. Documentation and examples
## Thanks
Special thanks to these open-source projects that provided inspiration:
- [react-pdf-headless](https://github.com/jkgenser/react-pdf-headless)
- [pdfreader](https://github.com/OnedocLabs/pdfreader)
## License
MIT © [Unriddle AI]()