WebSpark.Bootswatch 1.32.0

.NET 8.0

dotnet add package WebSpark.Bootswatch --version 1.32.0

NuGet\Install-Package WebSpark.Bootswatch -Version 1.32.0

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="WebSpark.Bootswatch" Version="1.32.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="WebSpark.Bootswatch" Version="1.32.0" />
                    

                            Directory.Packages.props

<PackageReference Include="WebSpark.Bootswatch" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add WebSpark.Bootswatch --version 1.32.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: WebSpark.Bootswatch, 1.32.0"

#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.

#:package WebSpark.Bootswatch@1.32.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=WebSpark.Bootswatch&version=1.32.0
                    

                            Install as a Cake Addin

#tool nuget:?package=WebSpark.Bootswatch&version=1.32.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

WebSpark.Bootswatch

A .NET Razor Class Library that provides seamless integration of Bootswatch themes into ASP.NET Core applications. Built on Bootstrap 5, this library offers modern, responsive theming with dynamic theme switching, light/dark mode support, and comprehensive caching mechanisms.

Multi-Framework Support: Targets .NET 8.0 (LTS), .NET 9.0 (STS), and .NET 10.0 for maximum compatibility.

🚀 Quick Links

📦 NuGet Package: WebSpark.Bootswatch
🎨 Demo Site: bootswatch.markhazleton.com
📚 Documentation: GitHub Wiki
🐛 Issues: Report a Bug

✨ Features

🎨 Complete Bootswatch Integration: All official Bootswatch themes plus custom themes
🌓 Light/Dark Mode Support: Automatic theme detection and switching
⚡ High Performance: Built-in caching with StyleCache service
🔧 Easy Integration: Single-line setup with extension methods
📱 Responsive Design: Mobile-first Bootstrap 5 foundation
🎯 Tag Helper Support: <bootswatch-theme-switcher /> for easy UI integration
🔒 Production Ready: Comprehensive error handling and fallback mechanisms
📖 Full Documentation: IntelliSense support and XML documentation
🎁 Multi-Framework: Supports .NET 8.0 (LTS), 9.0 (STS), and 10.0

📋 Prerequisites

Framework Support

The library supports multiple .NET versions:

Framework	Status	Support Level
.NET 8.0	✅ Supported	LTS (Long Term Support)
.NET 9.0	✅ Supported	STS (Standard Term Support)
.NET 10.0	✅ Supported	Current Release

Your project can target any of these frameworks and will receive the appropriate version of the library.

Required Dependencies

<PackageReference Include="WebSpark.Bootswatch" Version="1.31.0" />
<PackageReference Include="WebSpark.HttpClientUtility" Version="2.1.1" />

Configuration Requirements

Add to your appsettings.json for dynamic theme fetching:

{
  "CsvOutputFolder": "c:\\temp\\WebSpark\\CsvOutput",
  "HttpRequestResultPollyOptions": {
    "MaxRetryAttempts": 3,
    "RetryDelaySeconds": 1,
    "CircuitBreakerThreshold": 3,
    "CircuitBreakerDurationSeconds": 10
  }
}

🛠️ Installation

Package Manager Console

Install-Package WebSpark.Bootswatch
Install-Package WebSpark.HttpClientUtility

.NET CLI

dotnet add package WebSpark.Bootswatch
dotnet add package WebSpark.HttpClientUtility

PackageReference

<PackageReference Include="WebSpark.Bootswatch" Version="1.31.0" />
<PackageReference Include="WebSpark.HttpClientUtility" Version="2.1.1" />

The NuGet package automatically selects the correct assembly based on your project's target framework.

⚡ Quick Start

1. Configure Services (`Program.cs`)

var builder = WebApplication.CreateBuilder(args);

// Add services
builder.Services.AddRazorPages();
builder.Services.AddHttpContextAccessor();
builder.Services.AddBootswatchThemeSwitcher();

var app = builder.Build();

// Configure pipeline
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseBootswatchAll(); // Must be before UseStaticFiles()
app.UseStaticFiles();
app.UseRouting();
app.MapRazorPages();

app.Run();

2. Update Layout (`_Layout.cshtml`)

@using WebSpark.Bootswatch.Services
@using WebSpark.Bootswatch.Helpers
@inject StyleCache StyleCache
<!DOCTYPE html>
<html lang="en" data-bs-theme="@(BootswatchThemeHelper.GetCurrentColorMode(Context))">
<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>@ViewData["Title"]</title>
    @{
        var themeName = BootswatchThemeHelper.GetCurrentThemeName(Context);
        var themeUrl = BootswatchThemeHelper.GetThemeUrl(StyleCache, themeName);
    }
    <link id="bootswatch-theme-stylesheet" rel="stylesheet" href="@themeUrl" />
    <script src="/_content/WebSpark.Bootswatch/js/bootswatch-theme-switcher.js"></script>
</head>
<body>
    <nav class="navbar navbar-expand-lg">
        <div class="container">
            
            <ul class="navbar-nav flex-grow-1">
                
            </ul>
            
            <bootswatch-theme-switcher />
        </div>
    </nav>
    
    <main>
        @RenderBody()
    </main>
    
    <script src="~/lib/bootstrap/dist/js/bootstrap.bundle.min.js"></script>
    @await RenderSectionAsync("Scripts", required: false)
</body>
</html>

3. Register Tag Helper (`_ViewImports.cshtml`)

@addTagHelper *, WebSpark.Bootswatch

🎯 Advanced Usage

StyleCache Service

public class HomeController : Controller
{
    private readonly StyleCache _styleCache;

    public HomeController(StyleCache styleCache)
    {
        _styleCache = styleCache;
    }

    public IActionResult Index()
    {
        // Get all available themes
        var allThemes = _styleCache.GetAllStyles();
        
        // Get specific theme
        var defaultTheme = _styleCache.GetStyle("default");
        
        return View(allThemes);
    }
}

Theme Helper Methods

// Get current theme information
var currentTheme = BootswatchThemeHelper.GetCurrentThemeName(Context);
var colorMode = BootswatchThemeHelper.GetCurrentColorMode(Context);
var themeUrl = BootswatchThemeHelper.GetThemeUrl(StyleCache, currentTheme);

// Generate theme switcher HTML
var switcherHtml = BootswatchThemeHelper.GetThemeSwitcherHtml(StyleCache, Context);

Custom Theme Integration

// Add custom themes to your StyleCache
public void ConfigureServices(IServiceCollection services)
{
    services.AddBootswatchThemeSwitcher();
    services.Configure<BootswatchOptions>(options =>
    {
        options.CustomThemes.Add(new StyleModel
        {
            Name = "custom-theme",
            Description = "My Custom Theme",
            CssPath = "/css/custom-theme.css"
        });
    });
}

🧪 Testing & Demo

Demo Project

Explore the complete implementation in our demo project:

git clone https://github.com/MarkHazleton/WebSpark.Bootswatch.git
cd WebSpark.Bootswatch
dotnet run --project WebSpark.Bootswatch.Demo

The demo showcases:

✅ All Bootswatch themes
✅ Light/dark mode switching
✅ Responsive design patterns
✅ Integration examples
✅ Performance optimizations

Multi-Framework Testing

The library includes comprehensive tests that run on all supported frameworks:

# Test all frameworks
dotnet test

# Test specific framework
dotnet test --framework net8.0
dotnet test --framework net9.0
dotnet test --framework net10.0

# Use PowerShell script for detailed output
.\run-multi-framework-tests.ps1

Our CI/CD pipeline runs separate test jobs for each framework, ensuring compatibility across all supported .NET versions.

🏗️ Architecture

Core Components

Component	Purpose	Lifecycle
`StyleCache`	Theme data caching	Singleton
`BootswatchStyleProvider`	Theme management	Scoped
`BootswatchThemeHelper`	Static utilities	Static
`BootswatchThemeSwitcherTagHelper`	UI component	Transient

Middleware Pipeline

The correct middleware order is crucial:

app.UseBootswatchStaticFiles(); // 1. Bootswatch static files
app.UseStaticFiles();           // 2. Application static files  
app.UseRouting();               // 3. Routing

Multi-Framework Package Structure

The NuGet package contains separate assemblies for each target framework:

WebSpark.Bootswatch.1.31.0.nupkg
├── lib/
│   ├── net8.0/
│   │   └── WebSpark.Bootswatch.dll
│   ├── net9.0/
│   │   └── WebSpark.Bootswatch.dll
│   └── net10.0/
│       └── WebSpark.Bootswatch.dll

Each assembly is compiled with framework-specific optimizations and references the appropriate version of dependencies.

🔧 Configuration Options

Middleware Configuration

// Full configuration
app.UseBootswatchAll();

// Or individual components
app.UseBootswatchStaticFiles();
app.UseBootswatchThemeRoutes();

Service Configuration

services.AddBootswatchThemeSwitcher(options =>
{
    options.DefaultTheme = "bootstrap";
    options.EnableCaching = true;
    options.CacheDurationMinutes = 60;
});

🚀 Performance

Caching Strategy

Theme Data: Cached in StyleCache singleton
HTTP Requests: Resilient HTTP client with Polly
Static Files: Embedded resources with cache headers
Background Loading: Non-blocking theme initialization

Bundle Optimization

CSS: Minified Bootswatch themes
JavaScript: Lightweight theme switcher (~2KB)
Icons: Optimized SVG assets

Framework-Specific Optimizations

Each target framework receives optimized builds:

.NET 8.0: LTS-optimized with proven stability
.NET 9.0: Enhanced performance features
.NET 10.0: Latest runtime optimizations

🔒 Security

✅ Input Validation: Theme names sanitized and validated
✅ XSS Protection: HTML encoding in all outputs
✅ HTTPS: Secure external resource loading
✅ CSP Friendly: No inline scripts or styles
✅ CORS Compliant: Proper resource sharing policies

🛠️ Troubleshooting

Common Issues

Issue	Solution
Themes not loading	Check middleware order: `UseBootswatchAll()` before `UseStaticFiles()`
Theme switcher not visible	Ensure `@addTagHelper *, WebSpark.Bootswatch` in `_ViewImports.cshtml`
Missing dependencies	Install `WebSpark.HttpClientUtility` package
Configuration errors	Add required `appsettings.json` configuration
Wrong framework version	NuGet automatically selects correct version based on your target framework

Debug Mode

Enable detailed logging:

builder.Services.AddLogging(config =>
{
    config.AddConsole();
    config.SetMinimumLevel(LogLevel.Debug);
});

📊 Browser Support

Browser	Version	Status
Chrome	90+	✅ Fully Supported
Firefox	88+	✅ Fully Supported
Safari	14+	✅ Fully Supported
Edge	90+	✅ Fully Supported
IE	11	❌ Not Supported

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Development Setup

# Clone repository
git clone https://github.com/MarkHazleton/WebSpark.Bootswatch.git
cd WebSpark.Bootswatch

# Restore dependencies
dotnet restore

# Build solution (builds for all target frameworks)
dotnet build

# Run tests (tests all frameworks)
dotnet test

# Run demo
dotnet run --project WebSpark.Bootswatch.Demo

Testing Contributions

When contributing, ensure your changes work across all target frameworks:

# Run comprehensive multi-framework tests
.\run-multi-framework-tests.ps1 -Configuration Release

Contribution Areas

🐛 Bug fixes and improvements
📚 Documentation enhancements
🎨 New theme contributions
🧪 Test coverage expansion
🚀 Performance optimizations
🎯 Framework-specific optimizations

📝 Changelog

[1.31.0] - 2025-01-13

✅ Multi-Framework Support: Added .NET 8.0, 9.0, and 10.0 targeting
✅ Updated Dependencies: Framework-specific package versions
✅ Comprehensive Testing: Multi-framework test suite with CI/CD
✅ Removed Legacy Code: Eliminated System.Text.RegularExpressions (now in BCL)
✅ No Breaking Changes: Fully backward compatible

[1.30.0] - 2025-01-07

✅ Updated all NuGet dependencies to latest versions
✅ Enhanced security with latest dependency versions
✅ No breaking changes

[1.10.3] - 2025-05-20

✅ Patch release with minor improvements
✅ Enhanced logging and diagnostics

[1.10.0] - 2025-05-15

✅ Added Bootswatch Theme Switcher Tag Helper
✅ Included sample layout file in NuGet package
✅ Improved documentation and integration guides

View Full Changelog

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Third-Party Licenses

Bootstrap: MIT License
Bootswatch: MIT License
WebSpark.HttpClientUtility: MIT License

See NOTICE.txt for complete attribution.

🙏 Acknowledgments

Bootstrap Team - For the amazing Bootstrap framework
Thomas Park - Creator of Bootswatch themes
.NET Team - For excellent multi-targeting support
Contributors - Everyone who has contributed to this project

📞 Support

📖 Documentation: GitHub Wiki
🐛 Bug Reports: GitHub Issues
💬 Discussions: GitHub Discussions
📧 Email: Contact Author

<div align="center"> <p>Made with ❤️ by <a href="https://github.com/MarkHazleton">Mark Hazleton</a></p> <p> <a href="https://github.com/MarkHazleton/WebSpark.Bootswatch">⭐ Star this repo</a> • <a href="https://github.com/MarkHazleton/WebSpark.Bootswatch/fork">🔀 Fork</a> • <a href="https://github.com/MarkHazleton/WebSpark.Bootswatch/issues">🐛 Report Bug</a> • <a href="https://github.com/MarkHazleton/WebSpark.Bootswatch/discussions">💬 Discuss</a> </p> </div>

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser 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. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- Microsoft.AspNetCore.Mvc.Razor (>= 2.3.0)
- Microsoft.AspNetCore.Mvc.ViewFeatures (>= 2.3.0)
- Microsoft.AspNetCore.StaticFiles (>= 2.3.0)
- Microsoft.Extensions.FileProviders.Embedded (>= 10.0.0)
- WebSpark.HttpClientUtility (>= 2.1.1)
net8.0
- Microsoft.AspNetCore.Mvc.Razor (>= 2.3.0)
- Microsoft.AspNetCore.Mvc.ViewFeatures (>= 2.3.0)
- Microsoft.AspNetCore.StaticFiles (>= 2.3.0)
- Microsoft.Extensions.FileProviders.Embedded (>= 8.0.11)
- WebSpark.HttpClientUtility (>= 2.1.1)
net9.0
- Microsoft.AspNetCore.Mvc.Razor (>= 2.3.0)
- Microsoft.AspNetCore.Mvc.ViewFeatures (>= 2.3.0)
- Microsoft.AspNetCore.StaticFiles (>= 2.3.0)
- Microsoft.Extensions.FileProviders.Embedded (>= 9.0.9)
- WebSpark.HttpClientUtility (>= 2.1.1)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
1.32.0	270	11/13/2025
1.30.0	120	9/27/2025
1.20.1	213	7/1/2025
1.10.3	211	5/21/2025
1.10.2	196	5/20/2025
1.10.1	210	5/18/2025
1.10.0	283	5/15/2025
1.0.7	282	5/15/2025
1.0.6	229	5/5/2025
1.0.5	207	5/5/2025
1.0.4	207	5/4/2025
1.0.3	199	5/4/2025
1.0.2	186	5/4/2025

Version 1.32.0: Multi-targeting support for .NET 8.0, 9.0, and 10.0. Updated Microsoft.Extensions.FileProviders.Embedded to align with target frameworks. Comprehensive test suite with 33 tests across all frameworks. Removed redundant System.Text.RegularExpressions package reference (now included in framework). GitHub Actions CI/CD with multi-framework testing.