Osirion.Blazor 2.1.1

Osirion.Blazor

A modular, high-performance component library for Blazor applications with SSR compatibility and zero-JS dependencies (when possible).

✨ Features

Osirion.Blazor is composed of specialized modules that can be used independently or together:

📊 Analytics

• Multiple provider support (Microsoft Clarity, Matomo, GA4, Yandex Metrica)
• SSR compatibility with progressive enhancement
• Privacy-focused with consent management
• Easily extendable with your own providers

🧭 Navigation

• Enhanced navigation with scroll restoration
• Smooth scrolling and "back to top" functionality
• Works without JavaScript through progressive enhancement
• Fully customizable appearance

📝 Content Management

• GitHub and file system content providers
• Markdown rendering with frontmatter support
• Content organization with categories and tags
• Directory-based navigation and search
• SEO optimization out of the box

🎨 Theming

• Integration with popular CSS frameworks (Bootstrap, FluentUI, MudBlazor, Radzen)
• Dark mode support with system preference detection
• CSS variable-based styling system
• Minimal JavaScript with progressive enhancement

📦 Installation

Install the complete package:

dotnet add package Osirion.Blazor

Or just the modules you need:

dotnet add package Osirion.Blazor.Core
dotnet add package Osirion.Blazor.Analytics
dotnet add package Osirion.Blazor.Navigation
dotnet add package Osirion.Blazor.Cms
dotnet add package Osirion.Blazor.Theming

🚀 Quick Start

Service Registration

// In Program.cs
using Osirion.Blazor.Extensions;

// Register all services at once
builder.Services.AddOsirionBlazor(osirion => {
    osirion
        .AddGitHubCms(options => {
            options.Owner = "username";
            options.Repository = "content-repo";
        })
        .AddScrollToTop()
        .AddClarityTracker(options => {
            options.SiteId = "clarity-id";
        })
        .AddOsirionStyle(CssFramework.Bootstrap);
});

// Or from configuration
builder.Services.AddOsirionBlazor(builder.Configuration);

Component Usage

@using Osirion.Blazor.Components


<OsirionStyles FrameworkIntegration="CssFramework.Bootstrap" />
<EnhancedNavigation Behavior="ScrollBehavior.Smooth" />
<ScrollToTop Position="Position.BottomRight" />
<ClarityTracker />


<ContentList Directory="blog" />
<ContentView Path="blog/my-post.md" />
<SearchBox />
<TagCloud />

📚 Documentation

• Quick Reference - Quick overview of all components
• Analytics - Analytics integration documentation
• Navigation - Navigation components documentation
• GitHub CMS - Content management documentation
• Styling - Theming and styling documentation
• Migration Guide - Guide for upgrading between versions

🌟 Key Principles

• SSR First: All components designed for Server-Side Rendering compatibility
• Zero-JS Dependencies: No JavaScript dependencies where possible
• Progressive Enhancement: Core functionality works without JavaScript, enhanced with JS when available
• Framework Integration: Seamless integration with popular CSS frameworks
• Multi-Platform: Supports .NET 8 and .NET 9 (and future versions)
• Provider Pattern: Easily extend with your own providers for analytics, content, etc.

📋 Requirements

• .NET 8.0 or higher
• Blazor (Server, WebAssembly, or Auto)

🧪 Features Coming Soon

• Headless CMS support with Contentful, Sanity, and Strapi providers
• Form validation and submission components
• Authentication integration
• Enhanced SEO components with structured data
• Performance optimizations for large content repositories

🤝 Contributing

Contributions are welcome! Please see our Contributing Guidelines for details.

📄 License

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