View PDF files using PDF Viewer Component in the Blazor WASM app

29 Jan 20255 minutes to read

In this section, we’ll guide you through the process of adding Syncfusion® Blazor PDF Viewer component to your Blazor WebAssembly (WASM) app. We’ll break it down into simple steps to make it easy to follow. Additionally, you can find a fully functional example project on our GitHub repository.

Prerequisites

System requirements for Blazor components
To use the PDF Viewer component in a Blazor WebAssembly application with SkiaSharp, make sure to have the required .NET workloads installed by executing the following commands in the command prompt.
- dotnet workload install wasm-tools
- dotnet workload install wasm-tools-net6

Create a new Blazor App in Visual Studio

You can create a Blazor WebAssembly App using Visual Studio via Microsoft Templates or the Syncfusion^® Blazor Extension.

NOTE

The PDF Viewer component is supported from .NET 6.0 onwards.

Install Syncfusion^® Blazor SfPdfViewer and Themes NuGet in the App

To add Blazor PDFViewer component in the app, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search and install

NOTE

On the Syncfusion^® side, we are using SkiaSharp.Views.Blazor version 3.116.1. Please make sure to reference this version as well.

Create a new Blazor App in Visual Studio Code

You can create a Blazor WebAssembly App using Visual Studio Code via Microsoft Templates or the Syncfusion^® Blazor Extension.

Alternatively, you can create a WebAssembly application using the following command in the terminal(Ctrl+`).

Blazor WASM App
dotnet new blazorwasm -o BlazorApp
cd BlazorApp

NOTE

The PDF Viewer component is supported from .NET 6.0 onwards.

Install Syncfusion^® Blazor NuGet Package in the App

Press Ctrl+` to open the integrated terminal in Visual Studio Code.
Ensure you’re in the project root directory where your .csproj file is located.
Run the following command to install a Syncfusion.Blazor.SfPdfViewer, Syncfusion.Blazor.Themes and SkiaSharp.Views.Blazor NuGet package and ensure all dependencies are installed.

Package Manager
dotnet add package Syncfusion.Blazor.SfPdfViewer -v 28.2.3
dotnet add package Syncfusion.Blazor.Themes -v 28.2.3
dotnet add package SkiaSharp.Views.Blazor -v 3.116.1
dotnet restore

NOTE

On the Syncfusion^® side, we are using SkiaSharp.Views.Blazor version 3.116.1. Please make sure to reference this version as well.

NOTE

Syncfusion^® Blazor components are available in nuget.org. Refer to NuGet packages topic for available NuGet packages list with component details.

Register Syncfusion^® Blazor Service

In the ~/_Imports.razor file, add the following namespaces:

~/_Imports.razor

@using Syncfusion.Blazor;
@using Syncfusion.Blazor.SfPdfViewer;

.NET 6 & .NET 7 (~/Program.cs)
using Microsoft.AspNetCore.Components.Web;
using Microsoft.AspNetCore.Components.WebAssembly.Hosting;
using Syncfusion.Blazor;

var builder = WebAssemblyHostBuilder.CreateDefault(args);
builder.RootComponents.Add<App>("#app");
builder.RootComponents.Add<HeadOutlet>("head::after");

builder.Services.AddMemoryCache();
builder.Services.AddScoped(sp => new HttpClient { BaseAddress = new Uri(builder.HostEnvironment.BaseAddress) });

// Add Syncfusion Blazor service to the container.
builder.Services.AddSyncfusionBlazor();
await builder.Build().RunAsync();

Adding stylesheet and script

Add the following stylesheet and script to the head section of the wwwroot/index.html file.

CSHTML
<head>
    <!-- Syncfusion Blazor PDF Viewer control's theme style sheet -->
    <link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
    <!-- Syncfusion Blazor PDF Viewer control's scripts -->
    <script src="_content/Syncfusion.Blazor.SfPdfViewer/scripts/syncfusion-blazor-sfpdfviewer.min.js" type="text/javascript"></script>
</head>

Adding Blazor PDF Viewer Component

Add the Syncfusion^® PDF Viewer (Next Gen) component in the ~/Pages/Index.razor file.

RAZOR
@page "/"

<SfPdfViewer2 DocumentPath="https://cdn.syncfusion.com/content/pdf/pdf-succinctly.pdf"
              Height="100%"
              Width="100%">
</SfPdfViewer2>

NOTE

If you don’t provide the DocumentPath property value, the PDF Viewer component will be rendered without loading the PDF document. Users can then use the open option from the toolbar to browse and open the PDF as required.

Run the application

Run the application, and the PDF file will be displayed using Syncfusion® Blazor PDF Viewer component in your browser.