jsakamoto / Toolbelt.Blazor.InvokeDownloadAsync

Add InvokeDownloadAsync(name, type, contentBytes) extension method on your Blazor Apps.

Blazor InvokeDownloadAsync

Summary

This NuGet package simply adds the InvokeDownloadAsync() extension method on your Blazor apps.

@inject IJSRuntime JSRuntime

<button @onclick="BeginDownloadAsync">
  Begin Download
</button>
...
@code
{
  ...
  private async Task BeginDownloadAsync()
  {
    ...
    await this.JSRuntime.InvokeDownloadAsync(
      "Foo.png",
      "image/png",
      pictureBytes);
  }
}

Features

1. 100% eval() free

This package uses the standard InvokeAsync("import",...) method calling to import helper JavaScript code that is written as an ES module. 100% eval() free. (Instead, this package can not use for apps on .NET Core 3.x.)

2. Minimal setup

This package is an extension method for the IJSRuntime interface. You can use the downloading feature immediately if there is a JavaScript runtime object. You don't need to write any code in your startup.

3. Small package size

This package is simple and small content size because this package doesn't have massive code optimized for performance.

Usage

Install this NuGet package to your Blazor application project.

dotnet add package Toolbelt.Blazor.InvokeDownloadAsync

After that, you can use the InvokeDownloadAsync() extension method for the IJSRuntime interface.

Syntax

ValueTask InvokeDownloadAsync(
      this IJSRuntime jsRuntime,
      string fileName,
      string contentType,
      byte[] contentBytes);

IImplicit using the namespace

To use the InvokeDownloadAsync() extension method it requires open the namespace Toolbelt.Blazor.Extensions.Downloading. But in a general case, you don't need to open the namespace Toolbelt.Blazor.Extensions.Downloading explicitly because the NuGet package opens it implicitly by default.

To prevent this default behavior, please set the ImplicitUsingsToolbeltBlazorExtensionsDownloading MSBuild property to false.

<!-- 📄 Your .csproj file -->
<Project>
  ...
  <PropertyGroup>
    ...
    <ImplicitUsingsToolbeltBlazorExtensionsDownloading>false</ImplicitUsingsToolbeltBlazorExtensionsDownloading>
    ...

To use this library on .NET 5, you must open the Toolbelt.Blazor.Extensions.Downloading namespace explicitly.

Release notes

Release notes is here.

License

MIT License