WebSpark.Bootswatch provides Bootswatch themes for ASP.NET Core applications. It
includes custom themes and styles that can be easily integrated with ASP.NET Core MVC or Razor
Pages applications. Supports .NET 8.0, 9.0, and 10.0.
⚠️ IMPORTANT: This package requires WebSpark.HttpClientUtility to be installed and registered
separately.
SETUP:
1. Install: dotnet add package WebSpark.HttpClientUtility
2. Register: builder.Services.AddHttpClientUtility(); (BEFORE AddBootswatchThemeSwitcher)
3. Configure appsettings.json with HttpRequestResultPollyOptions section
See package README for complete setup guide.
A .NET Razor Class Library for integrating Bootstrap 5 themes from Bootswatch into ASP.NET Core applications. This library simplifies the process of applying modern, responsive themes to your web applications, leveraging the power of Bootstrap 5.
Theme Switching Prerequisites
To enable dynamic theme switching and fetch the list of available Bootswatch themes (as demonstrated in the demo project), you must:
Install the required NuGet packages:
WebSpark.Bootswatch
WebSpark.HttpClientUtility (required for fetching the list of themes)
Install both via NuGet Package Manager or .NET CLI:
Add required configuration to appsettings.json:
The WebSpark.HttpClientUtility package requires the following configuration for HTTP request resilience and output folder:
Note: Without these dependencies and configuration, theme switching and dynamic theme listing will not function in your application or the demo project.
Seamless integration of Bootswatch themes with ASP.NET Core applications.
Built on Bootstrap 5, offering modern, responsive, and mobile-first design.
NEW! Integrated theme switcher component with light/dark mode support.
Easy runtime theme switching with cookie persistence.
Includes custom themes (e.g., Mom, Texecon) alongside standard Bootswatch themes.
Built-in caching mechanism for improved performance through StyleCache service.
Fully documented with IntelliSense support.
Benefits of Bootstrap 5
Responsive Design: Build mobile-first, responsive web applications effortlessly.
Modern Components: Access a wide range of pre-designed components.
Customizable: Easily customize themes to match your branding.
No jQuery Dependency: Bootstrap 5 removes the dependency on jQuery, making it lighter and faster.
Installation
Install the package via NuGet Package Manager:
Install-Package WebSpark.Bootswatch
Or via .NET CLI:
dotnet add package WebSpark.Bootswatch
Quick Start
1. Register Services
In the Program.cs file of your ASP.NET Core application, register the Bootswatch services. If you use the Tag Helper, also add AddHttpContextAccessor():
var builder = WebApplication.CreateBuilder(args);
// Add services to the container
builder.Services.AddRazorPages();
// (Optional) If you use the Tag Helper, add HttpContextAccessor
builder.Services.AddHttpContextAccessor();
// Add Bootswatch theme switcher services (includes StyleCache)
builder.Services.AddBootswatchThemeSwitcher();
var app = builder.Build();
// Configure the HTTP request pipeline
if (!app.Environment.IsDevelopment())
{
app.UseExceptionHandler("/Error");
app.UseHsts();
}
app.UseHttpsRedirection();
// Use all Bootswatch features (includes StyleCache and static files)
app.UseBootswatchAll();
// (Optional) Add custom static file logging middleware if desired
// app.Use(...)
app.UseStaticFiles();
app.UseRouting();
app.MapRazorPages();
app.Run();
2. Update Your Layout
In your _Layout.cshtml, place the theme switcher Tag Helper outside the <ul class="navbar-nav flex-grow-1"> and after the navigation links, as shown in the demo:
<!-- ...existing nav markup... -->
<ul class="navbar-nav flex-grow-1">
<!-- nav items -->
</ul>
<bootswatch-theme-switcher />
<!-- ...rest of layout... -->
This ensures the theme switcher appears in the correct place in the navigation bar, matching the demo project.
Register the Tag Helper in your _ViewImports.cshtml:
@addTagHelper *, WebSpark.Bootswatch
If you use the manual method, do not place both the Tag Helper and the manual HTML helper in the same layout to avoid duplicate selectors.
The rest of your layout setup remains the same. See the included sample layout file for a full example.
No JavaScript implementation is needed—the theme switcher functionality is built into the library!
Advanced Usage
Using the Integrated StyleCache Service
The package includes a built-in StyleCache service for improved performance:
// In your Controller or Razor Page
using WebSpark.Bootswatch.Services;
public class HomeController : Controller
{
private readonly StyleCache _styleCache;
public HomeController(StyleCache styleCache)
{
_styleCache = styleCache;
}
public IActionResult Index()
{
// Get all available styles
var styles = _styleCache.GetAllStyles();
// Get a specific style by name
var defaultStyle = _styleCache.GetStyle("default");
return View();
}
}
Theme Switcher Helpers
The library includes the BootswatchThemeHelper class with useful methods. In Razor Pages, use Context:
// Get the current theme name
var themeName = BootswatchThemeHelper.GetCurrentThemeName(Context);
// Get the current color mode (light/dark)
var colorMode = BootswatchThemeHelper.GetCurrentColorMode(Context);
// Get the URL for a theme
var themeUrl = BootswatchThemeHelper.GetThemeUrl(StyleCache, themeName);
// Get HTML for the theme switcher component
var switcherHtml = BootswatchThemeHelper.GetThemeSwitcherHtml(StyleCache, Context);
Copy or reference this file to quickly set up your layout.
Demo Project
For a complete example of how to integrate WebSpark.Bootswatch, refer to the WebSpark.Bootswatch.Demo project included in this repository. It demonstrates:
Registering Bootswatch services.
Using the theme switcher component.
Applying themes dynamically in the layout.
Using the StyleCache service for efficient theme management.
Release Notes
v1.10.3 (2025-05-20)
Patch release. No breaking changes; all integration steps remain the same as v1.10.1.
v1.10.1 (2025-05-18)
Improved logging and diagnostics for static file and theme CSS requests in the demo project.
Updated Privacy.cshtml.cs to log the current color mode and use required members for better compatibility.
Minor code cleanup and documentation improvements in the demo and main library.
Updated project files for compatibility with .NET 9 (demo) and .NET 7 (library).
No breaking changes; all integration steps remain the same as v1.10.0.
v1.10.0 (2025-05-15)
Added a Bootswatch theme switcher Tag Helper (<bootswatch-theme-switcher />) for easy integration in layouts and navigation bars.
Included a sample layout file in the NuGet package for quick reference and copy-paste setup.
Updated documentation and demo to use the Tag Helper as the preferred method.
Added instructions and support for AddHttpContextAccessor() when using the Tag Helper.
Improved README and install guide to clarify integration steps and best practices.
Ensured static files and theme switcher JS are always available and documented correct middleware order.
Cleaned up demo layout to avoid duplicate theme switchers and match recommended usage.
License
This project is licensed under the MIT License - see the LICENSE file for details.
