pdfrx

This repository contains two Dart/Flutter packages for PDF rendering and viewing:

Packages

pdfrx_engine

A platform-agnostic PDF rendering API built on top of PDFium.

• Pure Dart package (no Flutter dependencies)
• Provides low-level PDF document API
• Can be used in CLI applications or non-Flutter Dart projects
• Supports all platforms: Android, iOS, Windows, macOS, Linux

pdfrx

A cross-platform PDF viewer plugin for Flutter.

• Flutter plugin with UI widgets
• Built on top of pdfrx_engine
• Provides high-level viewer widgets and overlays
• Includes text selection, search, zoom controls, and more

When to Use Which Package

• Use pdfrx if you're building a Flutter application and need PDF viewing capabilities with UI
• Use pdfrx_engine if you need PDF rendering without Flutter dependencies (e.g., server-side PDF processing, CLI tools)

Getting Started

For Flutter Applications

Add pdfrx to your pubspec.yaml:

dependencies:
  pdfrx: ^2.1.12

For Pure Dart Applications

Add pdfrx_engine to your pubspec.yaml:

dependencies:
  pdfrx_engine: ^0.1.15

Documentation

Comprehensive documentation is available in the doc/ directory, including:

• Getting started guides
• Feature tutorials
• Platform-specific configurations
• Code examples

Development

This is a monorepo managed with pub workspaces. Just do dart pub get on some directory inside the repo to obtain all the dependencies.

Example Application

The example viewer application is located in packages/pdfrx/example/viewer/. It demonstrates the full capabilities of the pdfrx Flutter plugin.

cd packages/pdfrx/example/viewer
flutter run

Contributing

Contributions are welcome! Please read the individual package READMEs for specific development guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.