How bjarnef/umbraco.community.hotspots works
Project type and purpose
• This is an Umbraco v13+ package (plugin) called “Umbraco Community Hotspots.”
• Purpose: provide a “hotspot” property editor in the Umbraco backoffice and delivery API extensions so frontend consumers (Razor sites or headless consumers) can render hotspot-able images or areas.
File structure
• Top-level:
• src/Umbraco.Community.Hotspots.TestSite – a sample ASP.NET Core web app illustrating how the package is consumed in a Razor/Umbraco site.
• src/Umbraco.Community.Hotspots – the actual plugin project, containing:
– Converters (C# classes that map stored data to runtime types)
– Extensions (Delivery API image extensions)
– PropertyEditors (definition of custom editor configuration, value editor, UI assets)
– wwwroot/… – JavaScript controllers and HTML views for the backoffice editor UI
– HotspotsComposer & HotspotsManifestFilter – code to register the editor with Umbraco’s DI and client-side manifest.
• Config/build: .csproj files, GitHub workflows, NuGet packaging (umbraco-marketplace.json), docs folder for NuGet instructions.
README
• Confirms it’s a NuGet-distributed Umbraco package.
• Installation is via dotnet CLI into an existing Umbraco site.
a. Main components
1. Umbraco Core CMS (ASP.NET Core host, Umbraco services, backoffice API)
2. Hotspots Package (server-side library loaded at application start)
– Composers & Filters to register manifest assets
– Converters & Models for data handling
– Delivery API Extensions for headless/data consumption
3. Backoffice Editor UI (JavaScript controllers + HTML in wwwroot)
4. Sample/Test Website (ASP.NET Razor site showing render of hotspots)
5. Underlying Database (Umbraco’s SQL store)
6. External Delivery API clients (optional headless consumers)
b. Relationships & interactions
• At startup, HotspotsComposer hooks into Umbraco’s startup pipeline → registers property editor manifest via HotspotsManifestFilter → backoffice loads JS controllers and HTML.
• Author uses backoffice UI to configure hotspots on images → data saved to Umbraco DB with custom data type (converter transforms stored JSON into .NET object).
• Razor website (TestSite) requests content via Umbraco Content Delivery API → DeliveryApiImageExtensions inject hotspot metadata into API response.
• Frontend rendering (Razor/JS) reads hotspot metadata and renders interactive image areas.
c. Architectural patterns/design principles
• Umbraco “Composer + Component” registration pattern
• Separation of concerns:
– UI assets served via manifest filter
– Data conversion in Converters
– Delivery API augmentation in Extensions
• Plugin packaged as NuGet for easy distribution
d. Key technologies/frameworks
• ASP.NET Core (Minimal host in TestSite/Umbraco host in target site)
• Umbraco CMS v13+
• JavaScript controllers (AngularJS-style backoffice)
• Razor views for sample site
• JSON-based property editor manifest
Capturing essential architectural elements
• Plugin registration pipeline (Composer, ManifestFilter)
• Data conversion layer
• Editor UI injection
• Delivery API augmentation