Getting Started with Blazor PDF Viewer Component in Blazor WASM App

8 Aug 20225 minutes to read

This section briefly explains about how to include Blazor PDF Viewer component in your Blazor WebAssembly (WASM) App using Visual Studio.

Prerequisites

Integrate PDF Viewer into Blazor WebAssembly App

  1. Start Visual Studio and select Create a new project.
  2. For a Blazor WebAssembly experience, choose the Blazor WebAssembly App template and select Next.
    Create-a-new-WASM-app
  3. Provide a Project name and confirm that the Location is correct. Select Next.
    Set-project-name
  4. In Additional information dialog, set target framework.
    Addition-information-WASM

Install Blazor PDFViewer NuGet package in WASM App

To add Blazor PDF Viewer component in Blazor WebAssembly App, use SfPdfViewer component in Syncfusion.Blazor.PdfViewer NuGet package.

This component requires server-side processing to render the PDF files through web service

Register Syncfusion Blazor Service

Open ~/_Imports.razor file and import the Syncfusion.Blazor namespace.

@using Syncfusion.Blazor

Now, register the Syncfusion Blazor Service in the Blazor WebAssembly App. Here, Syncfusion Blazor Service is registered by setting IgnoreScriptIsolation property as true to load the scripts externally in the next steps.

From 2022 Vol1 (20.1) version - The default value of IgnoreScriptIsolation is changed as true, so, you don’t have to set IgnoreScriptIsolation property explicitly to refer scripts externally.

  • Open ~/Program.cs file and register the Syncfusion Blazor Service in the client web app.
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.AddScoped(sp => new HttpClient { BaseAddress = new Uri(builder.HostEnvironment.BaseAddress) });

builder.Services.AddSyncfusionBlazor(options => { options.IgnoreScriptIsolation = true; });
await builder.Build().RunAsync();
....
using Syncfusion.Blazor;

namespace WebApplication1
{
    public class Program
    {
        public static async Task Main(string[] args)
        {
            ....
            builder.Services.AddSyncfusionBlazor(options => { options.IgnoreScriptIsolation = true; });
            await builder.Build().RunAsync();
        }
    }
}

Add Style Sheet

To add theme to the app, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search for Syncfusion.Blazor.Themes and then install it. Then, the theme style sheet from NuGet can be referred as follows,

Refer the theme style sheet from NuGet in the <head> of wwwroot/index.html file in the client web app.

<head>
    <link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
</head>

NOTE

Checkout the Blazor Themes topic to learn different ways (Static Web Assets, CDN and CRG) to refer themes in Blazor application, and to have the expected appearance for Syncfusion Blazor components. Here, the theme is referred using Static Web Assets. Refer to Enable static web assets usage topic to use static assets in your project.

Add Script Reference

In this getting started walk-through, the required scripts are referred using Static Web Assets externally inside the <head> as follows. Refer to Enable static web assets usage topic to use static assets in your project.

Refer script in the <head> of the ~/index.html file.

<head>
    ....
    <link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
    <script src="_content/Syncfusion.Blazor.PdfViewer/scripts/syncfusion-blazor-pdfviewer.min.js" type="text/javascript"></script>
</head>

NOTE

Checkout Adding Script Reference topic to learn different ways to add script reference in Blazor Application.

Syncfusion recommends to reference scripts using Static Web Assets, CDN and CRG by disabling JavaScript isolation for better loading performance of the Blazor application.

Add Blazor PDF Viewer Component

  • Open ~/_Imports.razor file or any other page under the ~/Pages folder where the component is to be added and import the Syncfusion.Blazor.PdfViewer namespace.
@using Syncfusion.Blazor
@using Syncfusion.Blazor.PdfViewer
  • Now, add the Syncfusion PDF Viewer component in razor file. Here, the PDF Viewer component is added in the ~/Pages/Index.razor file under the ~/Pages folder.
<SfPdfViewer DocumentPath="PDF_Succinctly.pdf" ServiceUrl="https://ej2services.syncfusion.com/production/web-services/api/pdfviewer" Height="500px" Width="1060px"></SfPdfViewer>

Server side processing

Since Syncfusion PDF Viewer (Blazor WebAssembly) component depends on server-side processing to render the PDF files, it is mandatory to create a web service as mentioned here
View web service sample in GitHub

Press Ctrl+F5 (Windows) or +F5 (macOS) to run the application. Then, the Syncfusion Blazor PDF Viewer component will be rendered in the default web browser.

Blazor PDF Viewer Component

View Sample in GitHub.