Toolbelt.Blazor.HeadElement 5.4.3-preview.1

.NET 5.0 .NET Standard 2.0
This is a prerelease version of Toolbelt.Blazor.HeadElement.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Toolbelt.Blazor.HeadElement --version 5.4.3-preview.1
NuGet\Install-Package Toolbelt.Blazor.HeadElement -Version 5.4.3-preview.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Toolbelt.Blazor.HeadElement" Version="5.4.3-preview.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Toolbelt.Blazor.HeadElement --version 5.4.3-preview.1
#r "nuget: Toolbelt.Blazor.HeadElement, 5.4.3-preview.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Toolbelt.Blazor.HeadElement as a Cake Addin
#addin nuget:?package=Toolbelt.Blazor.HeadElement&version=5.4.3-preview.1&prerelease

// Install Toolbelt.Blazor.HeadElement as a Cake Tool
#tool nuget:?package=Toolbelt.Blazor.HeadElement&version=5.4.3-preview.1&prerelease

Blazor Head Element Helper NuGet Package

Summary

This components and services allows you to change the title of document, "meta" elements such as OGP, and "link" elements such as canonical url, favicon etc. on your Blazor app.

This package supports both seiver-side Blazor and client-side Blazor WebAssembly app.

And also supports server-side pre-rendering on your server-side Blazor app.

See also following the live demonstration sites.

Notice

Blazor since .NET 5.0 Preview 8 also started to provide Title, Link, and Meta components by Microsoft.AspNetCore.Components.Web.Extensions NuGet package.

However, I'll continue to provide this package and keep to maintain, because this library still has some advantages.

To know what differences are there between this library and Microsoft.AspNetCore.Components.Web.Extensions 5.0 preview 8, please see the following table.

Feature This library .NET5 Preview 8
Server Pre-Rendering Supported. Not Supported, yet.
Respecting pre-rendered title Yes. No. It is never recovered if any components override it.
Overriding pre-rendered meta or link Can handle it properly. Just append it. it may cause duplication.
Canceling "meta http-equiv=refresh" Works well. There is no support.
Using it as a service, not components Supported. Not Supported.
To Including helper JavaScript Automatic. Required manually.

How to use

Installation

  1. Add package to your project like this.
dotnet add package Toolbelt.Blazor.HeadElement
  1. Register "Head Element Helper" service at your Blazor app's Startup.
using Toolbelt.Blazor.Extensions.DependencyInjection; // <- Add this, and...

public class Startup
{
  public void ConfigureServices(IServiceCollection services)
  {
    services.AddHeadElementHelper(); // <- Add this.
    ...

If the project is Blazor WebAssembly App v.3.2+, you should do it in Program class, instead.

using Toolbelt.Blazor.Extensions.DependencyInjection; // <- Add this, and...
...
public class Program
{
  public static async Task Main(string[] args)
  {
    var builder = WebAssemblyHostBuilder.CreateDefault(args);
    ...
    builder.Services.AddHeadElementHelper(); // <- Add this.
    ...
  1. Open Toolbelt.Blazor.HeadElement namespace in _Imports.razor file.
@* This is "_Imports.razor" *@
...
@using Toolbelt.Blazor.HeadElement

A. Change the title of the document

  1. Markup <Title> component in your .razor file.
@* This is "Pages/Counter.razor" *@
@page "/counter"

<Title>Counter(@currentCount) - Server Side App</Title>

The title of document will be changed.

fig1

B. Change "meta" elements

You can also add or override "meta" elements at runtime dynamically using <Meta> component like this.

@* This is "Pages/Counter.razor" *@
@page "/counter"

<Meta Property="ogp:title" Content="Counter" />

Note: You can also use native attribute names (lower and kebab case. ex: "http-equiv") instead of Razor component parameter names (pascal case).

You can add or override "link" elements at runtime dynamically using <Link> component like this.

@* This is "Pages/Counter.razor" *@
@page "/counter"

<Link Rel="icon" Href="@($"/favicons/{GetFaviconName()}")" />

fig3

Note: You can also use native attribute names (lower and kebab case) instead of Razor component parameter names (pascal case).

D. IHeadElementHelper

You can do these tasks by using IHeadElementHelper service instead of using <Title>, <Meta>, and <Link> components.

You can get the IHeadElementHelper service instnace by "Dependency Injection" mechanism.

@inject IHeadElementHelper HeadElementHelper
@using static Toolbelt.Blazor.HeadElement.MetaElement
...
@code {
  protected override async Task OnInitializedAsync()
  {
    await HeadElementHelper.SetTitleAsync("Wow!");
    await HeadElementHelper.SetMetaElementsAsync(
      ByName("description", "Foo bar..."),
      ByProp("og:title", "WoW!")
    );
    await HeadElementHelper.SetLinkElementsAsync(
      new LinkElement("canonical", "https://foo.com/bar")
    );
    ...

Server-side pre-rendering support

If you want to get srever-side pre-rendering support, do this.

  1. Add Toolbelt.Blazor.HeadElement.ServerPrerendering package to your project like this.
dotnet add package Toolbelt.Blazor.HeadElement.ServerPrerendering
  1. Register "Head Element Server Prerendering" middleware at your server-side Blazor app's Startup, before app.UseStaticFiles().
using Toolbelt.Blazor.Extensions.DependencyInjection; // <- Add this, and...
...
public class Startup
{
  ...
  public void ConfigureServices(IServiceCollection services)
  {
    services.AddHeadElementHelper(); // <!- Don't miss this line, and...
    ...

  public void Configure(IApplicationBuilder app)
  {
    app.UseHeadElementServerPrerendering(); // <- Add this.
    ...
    app.UseStaticFiles()
    ...

fig2

License

Mozilla Public License Version 2.0

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on Toolbelt.Blazor.HeadElement:

Repository Stars
jsakamoto/BlazorWasmPreRendering.Build
When you publish your Blazor Wasm app, this package pre-renders and saves the app as static HTML files in your public folder.
ADefWebserver/Blazor-Blogs
Simple blogging application written in Microsoft Server Side Blazor
jsakamoto/Toolbelt.Blazor.HeadElement
Head element support (change the document title, "meta" elements such as OGP, and "link" elements) for Blazor apps.
Version Downloads Last updated
7.3.1 12,278 12/16/2022
7.3.0 3,319 10/29/2022
7.3.0-preview.1 93 10/27/2022
7.2.1 2,698 9/18/2022
7.2.1-preview.1 108 9/8/2022
7.2.0 7,168 4/20/2022
7.1.1 603 4/12/2022
7.1.0 1,527 3/28/2022
7.0.0 3,085 1/23/2022
6.0.2 5,903 12/15/2021
6.0.1 1,876 11/30/2021
6.0.0 17,056 9/4/2021
6.0.0-preview.4 241 8/17/2021
6.0.0-preview.3 174 8/12/2021
6.0.0-preview.2 279 8/7/2021
6.0.0-preview.1 265 7/31/2021
5.4.3 3,894 7/30/2021
5.4.3-preview.1 318 7/10/2021
5.4.2 12,568 5/9/2021
5.4.1 13,576 1/30/2021
5.4.0 2,778 1/10/2021
5.3.0 409 1/10/2021
5.2.0 424 1/10/2021
5.1.0 821 1/9/2021
5.0.0 14,808 11/10/2020
5.0.0-rc.1 1,067 9/7/2020
1.2.0 13,310 6/4/2020
1.2.0-beta 303 5/29/2020
1.1.1 2,368 4/16/2020
1.1.0.1 1,511 1/18/2020
1.0.0 939 11/1/2019
0.0.1-preview2.0.2 294 9/19/2019
0.0.1-preview1.0.1 266 9/12/2019

v.5.4.3
- Fix: Updating title/meta/link elements at OnAfterRender doesn't any effects.