https://github.com/cl2raul66/mauipdfgenerator
Library for generating PDFs in .NET MAUI.
https://github.com/cl2raul66/mauipdfgenerator
c-sharp dot-net-maui fluent-api maui-library pdf-creator pdf-generation skiasharp
Last synced: 4 months ago
JSON representation
Library for generating PDFs in .NET MAUI.
- Host: GitHub
- URL: https://github.com/cl2raul66/mauipdfgenerator
- Owner: cl2raul66
- License: mpl-2.0
- Created: 2025-03-31T02:18:13.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-06-29T06:59:52.000Z (11 months ago)
- Last Synced: 2025-06-29T07:38:57.697Z (11 months ago)
- Topics: c-sharp, dot-net-maui, fluent-api, maui-library, pdf-creator, pdf-generation, skiasharp
- Language: C#
- Homepage:
- Size: 1.3 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
README
# MauiPdfGenerator
[](https://www.youtube.com/watch?v=km1ibZJeInM)
## Create PDFs with the .NET MAUI API You Already Know
**MauiPdfGenerator** is a library for .NET MAUI that allows you to generate PDF documents using a fluent, declarative API designed to feel like a natural extension of the MAUI ecosystem. Stop learning complex, external PDF libraries and start creating documents with the same concepts, components, and development patterns you use every day.
Our philosophy is simple: if you know how to build a UI in .NET MAUI, you already know how to create a PDF with `MauiPdfGenerator`.
For a complete guide, examples, and advanced patterns, **[visit our official Wiki](https://github.com/cl2raul66/MauiPdfGenerator/wiki)**.
---
## Why MauiPdfGenerator? The Developer Experience Ecosystem
This is more than just a PDF library; it's a complete ecosystem designed to maximize your productivity and minimize frustration.
- **`MauiPdfGenerator`**: The core engine, featuring a powerful layout system that emulates .NET MAUI's behavior for predictable results. Includes integrated diagnostics for effective debugging.
- **`MauiPdfGenerator.SourceGenerators`**: A smart code generator that eliminates "magic strings" for fonts, providing compile-time safety and IntelliSense for all your registered fonts.
Together, they provide a seamless and robust solution for creating professional PDFs, allowing you to focus on your application's logic, not on fighting with a new API.
## Features That Respect Your Time
### Core Engine (`MauiPdfGenerator`)
- **Fluent & Declarative API**: Build complex documents with readable, chainable methods.
- **MAUI-Native Components**: Use familiar concepts like `Grid`, `VerticalStackLayout`, `Image`, and `Paragraph`.
- **Intelligent Layout System**: The engine understands contextual defaults, `Margin`, `Padding`, and `LayoutOptions` just like MAUI.
- **Automatic Pagination**: Divisible elements like `Paragraph` and `Grid` flow across pages automatically, while atomic elements like `Image` and `StackLayout` maintain their integrity.
- **Rich Styling**: Customize fonts, colors, sizes, and text styles using the same `Microsoft.Maui` types you already use.
- **Full Document Control**: Define metadata, page size, orientation, and global styles with ease.
- **Integrated Diagnostics**: Get automatic, detailed feedback on common issues directly in your debug console and application logs by default.
- **Optional Visual Debugger**: Enable a powerful visual overlay that draws layout bounds, highlights overflow errors, and displays diagnostic codes directly on the generated PDF.
### Source Generators (`MauiPdfGenerator.SourceGenerators`)
- **Type-Safe Fonts**: Automatically generates a static `PdfFonts` class from your `MauiProgram.cs` configuration.
- **Eliminate Typos**: `PdfFonts.OpenSansBold` will compile. `"OpenSans-Bold"` might not. The generator ensures correctness at compile time.
- **Effortless Workflow**: Just configure your fonts once and let the generator do the rest.
## NuGet Packages
**MauiPdfGenerator** (includes integrated diagnostics)
[](https://www.nuget.org/packages/RandAMediaLabGroup.MauiPdfGenerator)
**MauiPdfGenerator.SourceGenerators**
[](https://www.nuget.org/packages/RandAMediaLabGroup.MauiPdfGenerator.SourceGenerators)
## Project Status
[](https://github.com/cl2raul66/MauiSystemFontFamily/actions/workflows/nuget-publish.yml)
The project is under active development. We are continuously adding new features and improving existing ones based on community feedback.
## Contributing
This project thrives on community involvement. Your contributions are essential to its success.
- **Star the Repository**: If you find this project useful, giving it a star on GitHub is a powerful way to show your support and increase its visibility.
- **Open Issues**: Found a bug or have an idea for a feature that would improve your workflow? Open an issue. We value detailed reports and thoughtful suggestions.
- **Pull Requests**: We welcome code contributions. Whether it's a bug fix, a new feature, or improved documentation, feel free to fork the repository and submit a pull request.
## License
This project is licensed under the terms of the `LICENSE.txt` file.