These components help readers move through content served by the Osirion CMS: category and tag links,
breadcrumbs, directory lists, previous and next links, series links, a table of contents and a search form. They
ship in the Osirion.Blazor.Cms.Web package, in the Osirion.Blazor.Cms.Web.Components namespace.
@using Osirion.Blazor.Cms.Web.Components
Components
| Component | What it renders | Where its data comes from |
|---|---|---|
| CategoriesList | Links to every category, with item counts | Loaded from the default content provider |
| TagCloud | Links to every tag, with item counts | Loaded from the default content provider, or the tags you pass |
| ContentBreadcrumbs | Home, the item's directories and the item title | The content item or directory you pass |
| DirectoryNavigation | A list of directories with one level of subdirectories | The directories you pass |
| LocalizedNavigation | A directory tree with links to content, for one locale | Loaded from the default content provider |
| OsirionContentNavigation | Previous and next links between the items of a directory | Loaded around the item you pass, or the neighbours you pass |
| ContentSeriesNavigation | "Part 2 of 5", the parts of a series and previous and next links (from 4.0) | Loaded from the items with the same series |
| TableOfContents | Links to the headings of an HTML string | The HTML you pass |
| SearchBox | A search form that submits with GET | None; your results page reads the query |
Before you start
Components that load data use IContentProviderManager, so a content provider must be registered. The example
apps register everything, including the CMS from the Osirion:Cms configuration section, with one call:
using Osirion.Blazor.Extensions;
builder.Services.AddOsirion(builder.Configuration);
Rendering
Every component here renders under static SSR. Links are plain anchors and the search box is a plain HTML form,
so none of them needs script. Components that load data do it in OnParametersSetAsync; without streaming
rendering, a statically rendered page is sent once the data is there. Click callbacks such as DirectoryClicked
run only in an interactive render mode.
Styling
Each component ships a scoped stylesheet whose colors, spacing and fonts come from the Osirion theme tokens
(--osirion-text-primary, --osirion-action-primary, --osirion-background-tertiary and others), so setting the
tokens or using a framework adapter restyles them with the rest of the site. Scoped rules carry an extra attribute
selector, so an override in your own stylesheet needs one more class or element than the rule it replaces, for
example .sidebar .osirion-categories-list .osirion-category-link.
Related
- CMS Web components
- Core CMS components, such as
ContentListfor category, tag and search result pages - OsirionBreadcrumbs, breadcrumbs built from a URL path instead of the content tree
Related Articles
