Katalyst.Portal.SharedUI 1.2.0

Portal.SharedUI

Portal.SharedUI is a Razor Class Library (RCL) that provides the shared shell for the organization portal: MVC partials, bridge styles, and a bundled third-party admin theme (Bootstrap-based) as static web assets. It is designed to be referenced by Portal.Web and by module apps (HRIS, LMS, etc.) so every surface shares the same chrome and look and feel.

For platform context, see the repository root ARCHITECTURE.md (shared UI package and /_content/Katalyst.Portal.SharedUI/ URLs).

Requirements

• .NET target: net10.0 (must match the consuming ASP.NET Core app).
• Host app: Microsoft.NET.Sdk.Web with MVC + Razor views (AddControllersWithViews, typical MapControllerRoute / static web assets pipeline).

What’s inside

Main partials (app shell)

Use these from the host _Layout.cshtml (see Portal.Web/Views/Shared/_Layout.cshtml as the reference implementation).

Marketing landing (optional)

Static files URL

All packaged wwwroot files are exposed at:

/_content/Katalyst.Portal.SharedUI/<path-under-wwwroot>

In Razor, prefer the tilde form so the app resolves the correct prefix:

<link rel="stylesheet" href="~/_content/Katalyst.Portal.SharedUI/css/portal-bridge.css" asp-append-version="true" />

Use in another project

Project reference (local / monorepo)

<ItemGroup>
  <ProjectReference Include="..\Portal.SharedUI\Portal.SharedUI.csproj" />
</ItemGroup>

NuGet package

<ItemGroup>
  <PackageReference Include="Katalyst.Portal.SharedUI" Version="x.y.z" />
</ItemGroup>

Host configuration

1. Add typical MVC + static assets setup (same generation as Portal.Web).

2. In Views/_ViewImports.cshtml, if you use package models:

   @using Portal.SharedUI.Models
   @addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
   

3. Compose Views/Shared/_Layout.cshtml with the partials above, @RenderBody(), session modal markup if you use portal-common.js token warning, and @RenderSection("Sidebar", required: false) between _PortalSidebarStart and _PortalSidebarEnd.

4. Nav behavior depends on ClaimsPrincipal and roles (see PortalTopNavHelper / ModuleDefinition). Align Keycloak (or your IdP) role claims with PortalModules or replace the partials with your own.

Pack performance

The package includes the full wwwroot/assets tree (thousands of files). dotnet pack can take a long time; that is expected.

Publishing to NuGet.org

Maintainers: step-by-step dotnet pack, metadata on the .csproj, and dotnet nuget push are documented in CONTRIBUTING.md.

License and vendor theme

Theme files under wwwroot/assets/ are third-party material. You must comply with the vendor license for use and for redistribution (including publishing this project as a NuGet package). The package author is responsible for nuget.org policy compliance.