Skip to content

A port of the BlazorBootstrap PDF viewer to work with MudBlazor

License

Notifications You must be signed in to change notification settings

tgothorp/MudBlazor.PdfViewer

Repository files navigation

Gotho.MudBlazor.PdfViewer

A port of the BlazorBootstrap PDF viewer to work with MudBlazor

Installation

Grab the package from nuget.org;

dotnet add package Gotho.MudBlazor.PdfViewer --version 1.1.0

Configure

Add the following to your application startup in Program.cs;

builder.Services.AddMudBlazorPdfViewer();

Update your App.razor file to import the required CSS;

<link href="_content/Gotho.MudBlazor.PdfViewer/mudpdf.min.css" rel="stylesheet"/>

Then, add the namespace to your _Imports.razor file;

@using MudBlazor.PdfViewer

You should now be fully setup to use the MudPdfViewer component in your code!

Prerequisites

In order to use this package, your project will need to be configured with the following;

  • MudBlazor Version 8.0.0 or later
  • .NET Version 8.0 or 9.0

Usage & Examples

Please see the documentation site for detailed examples

Contributing

Feel free to make contributions.

License

ℹ️ Important

Please read the following carefully as it may impact your ability to use this library.

This library is a port of the PdfViewer Blazor component provided by the Blazor Bootstrap component library which is licensed under the Apache 2.0 license.

This means that this project is also required to use the Apache 2.0 license which different to MudBlazor's MIT license. This difference may have consequences as to your ability to use this library.

It is your responsibility to determine that this license is compatible with your use-case.

Please see the NOTICE.md file for more information.