Osirion.Blazor
2.1.1
dotnet add package Osirion.Blazor --version 2.1.1
NuGet\Install-Package Osirion.Blazor -Version 2.1.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="Osirion.Blazor" Version="2.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Osirion.Blazor" Version="2.1.1" />
<PackageReference Include="Osirion.Blazor" />
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 Osirion.Blazor --version 2.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Osirion.Blazor, 2.1.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.
#addin nuget:?package=Osirion.Blazor&version=2.1.1
#tool nuget:?package=Osirion.Blazor&version=2.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
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.
Product | Versions 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 was computed. 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- Osirion.Blazor.Analytics (>= 2.1.1)
- Osirion.Blazor.Cms (>= 2.1.1)
- Osirion.Blazor.Core (>= 2.1.1)
- Osirion.Blazor.Navigation (>= 2.1.1)
- Osirion.Blazor.Theming (>= 2.1.1)
-
net9.0
- Osirion.Blazor.Analytics (>= 2.1.1)
- Osirion.Blazor.Cms (>= 2.1.1)
- Osirion.Blazor.Core (>= 2.1.1)
- Osirion.Blazor.Navigation (>= 2.1.1)
- Osirion.Blazor.Theming (>= 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 | |
---|---|---|---|
2.1.1 | 126 | 5/20/2025 | |
2.1.0 | 127 | 5/19/2025 | |
2.0.2 | 150 | 4/23/2025 | |
2.0.1 | 154 | 4/23/2025 | |
2.0.0 | 157 | 4/22/2025 | |
1.5.3 | 236 | 4/21/2025 | |
1.5.2 | 237 | 4/21/2025 | |
1.5.1 | 239 | 4/21/2025 | |
1.5.0 | 239 | 4/21/2025 | |
1.4.0 | 243 | 4/21/2025 | |
1.3.0 | 242 | 4/20/2025 | |
1.2.0 | 248 | 4/19/2025 | |
1.1.0 | 250 | 4/19/2025 | |
1.0.0 | 200 | 4/19/2025 |