Sidio.Sitemap.Blazor 2.0.2

Sidio.Sitemap.Blazor

Sidio.Sitemap.Blazor is a lightweight .NET library for generating sitemaps in Blazor server applications.

Versions

	Sidio.Sitemap.Core	Sidio.Sitemap.AspNetCore	Sidio.Sitemap.Blazor
NuGet
Build
Coverage
Requirements	.NET Standard, .NET 8+,	.NET 8+, AspNetCore	.NET 8+, AspNetCore, Blazor server

Installation

Add the package to your project.

Usage

Sitemap

Register services:

builder.Services
    .AddHttpContextAccessor()
    .AddDefaultSitemapServices<HttpContextBaseUrlProvider>();

Register the middleware. Make sure to choose the correct namespace.

using Sidio.Sitemap.Blazor;

app.UseSitemap();

Add the following attribute to your components (pages) to include them in the sitemap:

@* default *@
@attribute [Sitemap]

@* override route url *@
@attribute [Sitemap("/custom-url")]

@* add change frequency, priority and last modified date *@
@attribute [Sitemap(ChangeFrequency.Daily, 0.5, "2024-01-01")]

The sitemap is accessible at [domain]/sitemap.xml.

Providing additional nodes

You can provide additional sitemap nodes by implementing the ISitemapNodeProvider interface. The middleware will detect and use your implementation automatically.

// Implement the ICustomSitemapNodeProvider interface
public class MyCustomSitemapNodeProvider : ICustomSitemapNodeProvider
{
    public IEnumerable<SitemapNode> GetNodes()
    {
        return new List<SitemapNode> { new("/test") };
    }
}

// Register the provider in DI
services.AddCustomSitemapNodeProvider<MyCustomSitemapNodeProvider>();

Security

The HttpContextBaseUrlProvider uses Request.Host which is not considered safe by default. To mitigate this, use one of the following approaches:

• Implement a custom IBaseUrlProvider that uses a safe way to determine the base URL, for example by using IHttpContextAccessor and validating the host against a whitelist, or by loading a base URL from configuration.
• Configure Forwarded Headers middleware:

app.UseForwardedHeaders(new ForwardedHeadersOptions
{
    ForwardedHeaders = ForwardedHeaders.XForwardedHost | ForwardedHeaders.XForwardedProto,
    KnownProxies = { IPAddress.Parse("IP_ADDRESS_OF_YOUR_PROXY") }
});

Upgrade to v2.x

In v2.x the reference to Sidio.Sitemap.AspNetCore is replaced by Sidio.Sitemap.Core. This reduces dependencies and makes the library more lightweight.

Breaking changes:

• The ICustomSitemapNodeProvider now exists in namespace Sidio.Sitemap.Blazor.
• References or using-statements to Sidio.Sitemap.AspNetCore can be removed.

FAQ

• Exception: Unable to resolve service for type 'Microsoft.AspNetCore.Http.IHttpContextAccessor' while attempting to activate 'Sidio.Sitemap.Blazor.HttpContextBaseUrlProvider'.
  • Solution: call services.AddHttpContextAccessor(); to register the IHttpContextAccessor.
• Build error (v1.x): The call is ambiguous between the following methods or properties: 'Sidio.Sitemap.Blazor.ApplicationBuilderExtensions.UseSitemap(...)' and 'Sidio.Sitemap.AspNetCore.Middleware.ApplicationBuilderExtensions.UseSitemap(...)'
  • Solution: make sure to use the correct namespace: using Sidio.Sitemap.Blazor;, and not using Sidio.Sitemap.AspNetCore.Middleware;.

See also

• Sidio.Sitemap.Core package