CategoriesList

CategoriesList renders a list of links, one per content category, with the number of items in each. It loads the categories itself from the default content provider, so use it in a sidebar, on a home page or on a category page.

Package Osirion.Blazor.Cms.Web, namespace Osirion.Blazor.Cms.Web.Components. Source on GitHub.

@using Osirion.Blazor.Cms.Web.Components

@* The categories come from this site's own content, so the names and counts are real *@
<CategoriesList Title="Categories" MaxCategories="6" ActiveCategory="Components" />

The demo reads the categories of this site's own content and marks Components as the active one.

Usage

@using Osirion.Blazor.Cms.Web.Components

<CategoriesList Title="Categories" />

A category page that lists the items of one category and marks it in the list:

@page "/category/{Category}"
@using Osirion.Blazor.Cms.Web.Components

<ContentList Category="@Category" />

<aside>
    <CategoriesList Title="Categories"
                    ActiveCategory="@Category"
                    SortByCount="false" />
</aside>

@code {
    [Parameter]
    public string Category { get; set; } = string.Empty;
}

The default links go to /category/{slug}, which matches this route. ContentList passes the value to the content query, which matches a category by its name or by its slug, ignoring case, so the default links work for any category name. With your own CategoryUrlFormatter, read the value your own way and pass the name or the slug.

Parameters

Class goes on the outer div. Style and Theme are accepted but not written, and other attributes on the tag are captured but not rendered, so use Class rather than id or data- attributes.

Behavior

• Categories come from the categories front matter of every item the default provider holds, across all locales and including unpublished items. Names that differ only in case count as one category, shown with the spelling of the first item that has it; the count is the number of items that carry it.
• The list is loaded again on every parameter change. Caching belongs to the content provider, not the component.
• Under static SSR the response is sent with the finished list. LoadingText can show briefly in interactive render modes.
• With no default provider registered, or when the provider throws, NoContentText is shown. A provider error is logged through ILogger; its details never reach the page.
• Links carry rel="nofollow". Category names are written as text, so they are HTML-encoded.
• The current category is marked with a class only, not with aria-current.

Styling

Colors come from --osirion-text-primary, --osirion-text-secondary, --osirion-background-hover, --osirion-background-tertiary, --osirion-nav-active-background, --osirion-nav-active-text, --osirion-link-color and --osirion-action-primary.

Related

• TagCloud, the same idea for tags
• Content List, for the category page itself
• CMS navigation components