https://github.com/tgothorp/Gotho.BlazorPdf
A port of the BlazorBootstrap PDF viewer to work with MudBlazor
https://github.com/tgothorp/Gotho.BlazorPdf
blazor blazor-components blazor-server component csharp netcore pdf pdf-viewer
Last synced: 12 months ago
JSON representation
A port of the BlazorBootstrap PDF viewer to work with MudBlazor
- Host: GitHub
- URL: https://github.com/tgothorp/Gotho.BlazorPdf
- Owner: tgothorp
- License: apache-2.0
- Created: 2025-02-05T11:56:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-28T21:47:11.000Z (over 1 year ago)
- Last Synced: 2025-03-01T00:04:35.002Z (over 1 year ago)
- Topics: blazor, blazor-components, blazor-server, component, csharp, netcore, pdf, pdf-viewer
- Language: JavaScript
- Homepage: https://mudpdf.info
- Size: 3.37 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Blazor PDF (Formally Mud PDF)
Originally a port of the BlazorBootstrap PDF viewer for the [MudBlazor](https://mudblazor.com) component library. Blazor PDF is a simple yet powerful PDF viewer for Blazor framework.
## Contents
- [Installation](#installation)
* [Configuration](#Configuration)
- [Prerequisites](#prerequisites)
- [Usage & Examples](#usage---examples)
- [MudBlazor Integration](#mudblazor-integration)
- [Contributing](#contributing)
- [Icons](#icons)
- [License](#license)
## Installation
Grab the package from [nuget.org](www.nuget.org/packages/Gotho.BlazorPdf);
```
dotnet add package Gotho.BlazorPdf
```
### Configuration
Add the following to your application startup in `Program.cs`;
```
builder.Services.AddBlazorPdfViewer();
```
Update your `App.razor` file to import the required CSS;
```
```
Then, add the namespace to your `_Imports.razor` file;
```
@using Gotho.BlazorPdf
```
You should now be fully setup to use the `PdfViewer` component in your code!
## Prerequisites
In order to use this package, your project will need to be configured with the following;
- **.NET** Version 8.0 or 9.0
## Usage & Examples
Please see the [documentation site](https://blazorpdf.info/docs) for detailed examples
## MudBlazor Integration
A dedicated [MudBlazor-specific package](https://www.nuget.org/packages/Gotho.BlazorPdf.MudBlazor/#readme-body-tab) is available for use.
This project was previously known as MudPdf / MudBlazor.PdfViewer. This repo was updated and renamed to remove the MudBlazor dependency such that the library can be used by any Blazor project.
However, in keeping with the original spirit of this project, a separate, dedicated package for MudBlazor is available.
See the [documentation website](https://blazorpdf.info/docs/mudblazor/quickstart) for installation & usage details.
## Contributing
Feel free to make contributions, see the `CONTRIBUTING.md` file for more information.
## Icons
This project uses the excellent [feather icons](https://github.com/feathericons/feather) library.
## License
Licensed under Apache-2.0
This library contains code from the `PdfViewer` Blazor component provided by the [Blazor Bootstrap](https://github.com/vikramlearning/blazorbootstrap/tree/main/blazorbootstrap) component library as well as code from Mozilla's [pdf.js](https://github.com/mozilla/pdf.js#online-demo) library.
Both are licensed under the Apache 2.0 license.
See `NOTICE.md` for more information.