Osirion.Blazor.Core is the package with the page building blocks: layout, content, cards, sections, navigation, forms
and states. Every component renders complete HTML under static SSR; where a component uses script, the script adds
to markup that already works (the one exception is OsirionReveal, see Rendering below). Version 4.0.0 targets
.NET 9 and .NET 10.
Setup
Install the meta package, which includes Core, the theming package that loads its styles, and the AddOsirion
registration used below:
dotnet add package Osirion.Blazor
Register the services in Program.cs:
using Osirion.Blazor.Extensions;
builder.Services.AddOsirion(builder.Configuration);
// Components that enhance themselves with a script (page layout, carousels, metric cards,
// image gallery, reveal, video embeds, the HTML renderer) load it through BlazorJSComponents.
builder.Services.AddJSComponents();
Add the namespaces to _Imports.razor:
@using Osirion.Blazor.Components
@using Osirion.Blazor.Theming.Components
Render <OsirionStyles /> once in your layout. It links the Core stylesheet and the components' scoped CSS, and the
adapter for your CSS framework; see OsirionStyles.
Categories
| Category | Components |
|---|---|
| Layout | OsirionPageLayout (header, body and footer slots, sticky footer, and from 4.0 a skip link to the main content), OsirionFooter, OsirionStickySidebar, OsirionBackgroundPattern, OsirionPageLoading. |
| Content | OsirionArticleMetdata (author, date, read time). From 4.0: callouts, tabs, accordion and FAQ, responsive image, video embed, reading progress. |
| Cards | Feature, testimonial, subscription and metric cards, and from 4.0 OsirionAuthorCard. |
| Sections | HeroSection, OsirionBaseSection, OsirionContactInfoSection, OsirionResponsiveShowcaseSection, OsirionMetricGrid, OsirionContextCardGrid. From 4.0: OsirionPricingTable, OsirionFeatureComparison, OsirionSteps. |
| Navigation | OsirionBreadcrumbs and OsirionReadMoreLink. Menus and scroll helpers are in the Navigation package. |
| Carousels | InfiniteLogoCarousel and OsirionTestimonialCarousel. |
| Forms | OsirionContactForm, which posts under static SSR. The newsletter form is a card: OsirionSubscriptionCard. |
| Popups | OsirionCookieConsent, and from 4.0 OsirionAnnouncementBar, a site-wide notice that closes without script. |
| Rendering | OsirionHtmlRenderer, which sanitizes HTML and highlights code, and OsirionReveal, which fades content in as it scrolls into view. With Animate on (the default) the content starts hidden and only its script shows it, so do not wrap content that must be visible without script. |
| States | OsirionContentNotFound for missing content. |
OsirionImageGallery, a responsive image grid with an optional lightbox, is also part of Core and has no page yet.
Shared parameters
Core components derive from OsirionComponentBase (all except OsirionResponsiveShowcaseSection), which gives them
these parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
Class |
string? |
null |
Extra CSS classes. Most components add them to their root element. |
Style |
string? |
null |
Inline style, on the components that render it. |
Theme |
ThemeMode |
System |
Light, Dark or Inverted writes that value in data-theme (data-bs-theme with Bootstrap) on the component; System writes nothing. |
Attributes |
IDictionary<string, object> |
empty | Captures unmatched attributes such as id or aria-label. |
SetInteractive is obsolete and fails the build; components read the render mode from RendererInfo themselves.
Related
Related Articles
