New trigger and httpcontext extensions

dmkk3r · dmkk3r · commit 0f116e0f4705 · 2025-07-11T19:07:33.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/).
 
+## [0.3.0] - 2025-07-11
+
+### Added
+
+- HttpContext extensions to check htmx request headers
+- Add a Trigger to the RazorHxResult.
+
 ## [0.2.0] - 2025-01-13
 
 ### Added
diff --git a/README.md b/README.md
@@ -2,7 +2,9 @@
 
 [![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 
-This small helper library seamlessly combines HTMX with the latest Razor Components in the ASP.NET Core world. With this library, you can effortlessly return HTML through Minimal API endpoints, which is then rendered by Razor Components. Streamline development by harnessing the power of HTMX alongside the flexibility of Razor Components and Minimal APIs.
+This small helper library seamlessly combines HTMX with the latest Razor Components in the ASP.NET Core world. With this
+library, you can effortlessly return HTML through Minimal API endpoints, which is then rendered by Razor Components.
+Streamline development by harnessing the power of HTMX alongside the flexibility of Razor Components and Minimal APIs.
 
 ## Features
 
@@ -12,12 +14,15 @@ This small helper library seamlessly combines HTMX with the latest Razor Compone
 
 ## Installation
 
-To use RazorHx in your ASP.NET Core project, you only need to install the NuGet package. Open your project in the Package Manager Console and run the following command:
+To use RazorHx in your ASP.NET Core project, you only need to install the NuGet package. Open your project in the
+Package Manager Console and run the following command:
+
 ```bash
 Install-Package RazorHx
 ```
 
 Alternatively, you can use the .NET CLI with the following command:
+
 ```bash
 dotnet add package RazorHx
 ```
@@ -42,15 +47,46 @@ app.MapGet("/", () => new RazorHxResult<Hello>());
 app.Run();
 ```
 
-### "Out of Band" Components
+### Triggers
+
+[Read more at the official documentation site.](https://htmx.org/docs/#triggers)
+
+Create an endpoint which returns a RazorHxResult and append the WithTrigger extension to specify the event to trigger:
+
+```csharp
+app.MapGet("/", () => new RazorHxResult<Hello>()
+    .WithTrigger("event"));
+```
+
+Specify the timing, when the event should trigger:
+
+```csharp
+app.MapGet("/", () => new RazorHxResult<Hello>()
+    .WithTrigger("event", timing: TriggerTiming.Default)
+    .WithTrigger("event", timing: TriggerTiming.AfterSettle)
+    .WithTrigger("event", timing: TriggerTiming.AfterSwap));
+```
+
+Specify the condition, when the event should be included:
+
+```csharp
+app.MapGet("/", () => new RazorHxResult<Hello>()
+    .WithTrigger("event", include: false));
+```
+
+### Out of Band Swaps
+
+[Read more at the official documentation site.](https://htmx.org/docs/#oob_swaps)
 
 Create an endpoint which returns a RazorHxResult and append the WithOutOfBand extension to specify your oob component:
+
 ```csharp
 app.MapGet("/", () => new RazorHxResult<Hello>()
     .WithOutOfBand<World>());
 ```
 
-Define a slot in the DOM where the response will be swapped to: 
+Define a slot in the DOM where the response will be swapped to:
+
 ```html
 <!-- Hello.razor or somewhere in Layouts -->
 <div id="oob">
@@ -73,7 +109,8 @@ For a detailed changelog, please refer to the [CHANGELOG.md](CHANGELOG.md) file.
 
 ## Contributing
 
-We welcome contributions and feedback on these planned features. If you have specific features you'd like to see or would like to contribute to the development, please check our [contribution guidelines](CONTRIBUTING.md)
+We welcome contributions and feedback on these planned features. If you have specific features you'd like to see or
+would like to contribute to the development, please check our [contribution guidelines](CONTRIBUTING.md)
 
 ## License
 
diff --git a/src/RazorHx.Components/RazorHx.Components.csproj b/src/RazorHx.Components/RazorHx.Components.csproj
@@ -4,7 +4,6 @@
         <TargetFramework>net8.0</TargetFramework>
         <Nullable>enable</Nullable>
         <ImplicitUsings>enable</ImplicitUsings>
-        <Version>0.0.2</Version>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
         <Title>RazorHx</Title>
         <Authors>dmkk3r</Authors>
@@ -20,6 +19,10 @@
 
     <ItemGroup>
         <PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="8.0.11" />
+        <PackageReference Include="Nerdbank.GitVersioning" Version="3.7.115">
+          <PrivateAssets>all</PrivateAssets>
+          <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
     </ItemGroup>
 
 </Project>
diff --git a/src/RazorHx.Components/version.json b/src/RazorHx.Components/version.json
@@ -0,0 +1,14 @@
+{
+  "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json",
+  "version": "0.0.2",
+  "gitCommitIdShortAutoMinimum": 7,
+  "publicReleaseRefSpec": [
+    "^refs/heads/main$",
+    "^refs/tags/v\\d+(?:\\.\\d+)*(?:-[a-zA-Z0-9]+(?:\\.\\d+)*)?$"
+  ],
+  "cloudBuild": {
+    "buildNumber": {
+      "enabled": true
+    }
+  }
+}
diff --git a/src/RazorHx.Htmx/HtmxTrigger.cs b/src/RazorHx.Htmx/HtmxTrigger.cs
@@ -0,0 +1,8 @@
+namespace RazorHx.Htmx;
+
+public class HtmxTrigger
+{
+    public required string Name { get; init; }
+    public TriggerTiming Timing { get; init; }
+    public object? Parameters { get; init; }
+}
diff --git a/src/RazorHx.Htmx/RazorHx.Htmx.csproj b/src/RazorHx.Htmx/RazorHx.Htmx.csproj
@@ -4,7 +4,6 @@
         <TargetFramework>net8.0</TargetFramework>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
-        <Version>0.1.1</Version>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
         <Title>RazorHx</Title>
         <Authors>dmkk3r</Authors>
@@ -18,4 +17,11 @@
         <FrameworkReference Include="Microsoft.AspNetCore.App"/>
     </ItemGroup>
 
+    <ItemGroup>
+      <PackageReference Include="Nerdbank.GitVersioning" Version="3.7.115">
+        <PrivateAssets>all</PrivateAssets>
+        <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      </PackageReference>
+    </ItemGroup>
+
 </Project>
diff --git a/src/RazorHx.Htmx/TriggerTiming.cs b/src/RazorHx.Htmx/TriggerTiming.cs
@@ -0,0 +1,8 @@
+namespace RazorHx.Htmx;
+
+public enum TriggerTiming
+{
+    Default,
+    AfterSettle,
+    AfterSwap
+}
diff --git a/src/RazorHx.Htmx/version.json b/src/RazorHx.Htmx/version.json
@@ -0,0 +1,14 @@
+{
+  "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json",
+  "version": "0.2.0",
+  "gitCommitIdShortAutoMinimum": 7,
+  "publicReleaseRefSpec": [
+    "^refs/heads/main$",
+    "^refs/tags/v\\d+(?:\\.\\d+)*(?:-[a-zA-Z0-9]+(?:\\.\\d+)*)?$"
+  ],
+  "cloudBuild": {
+    "buildNumber": {
+      "enabled": true
+    }
+  }
+}
diff --git a/src/RazorHx/Extensions/ObjectExtensions.cs b/src/RazorHx/Extensions/ObjectExtensions.cs
@@ -1,8 +1,8 @@
 ﻿using System.ComponentModel;
 
-namespace RazorHx;
+namespace RazorHx.Extensions;
 
-public static class ObjectExtensions
+internal static class ObjectExtensions
 {
     public static Dictionary<string, object?> ToDictionary(this object? values)
     {
diff --git a/src/RazorHx/RazorHx.csproj b/src/RazorHx/RazorHx.csproj
@@ -4,7 +4,6 @@
         <TargetFramework>net8.0</TargetFramework>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
-        <Version>0.2.0</Version>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
         <Title>RazorHx</Title>
         <Authors>dmkk3r</Authors>
@@ -28,5 +27,12 @@
         <None Include="..\..\README.md" Pack="true" PackagePath="\"/>
         <None Include="..\..\LICENSE" Pack="true" PackagePath="\"/>
     </ItemGroup>
+
+    <ItemGroup>
+      <PackageReference Include="Nerdbank.GitVersioning" Version="3.7.115">
+        <PrivateAssets>all</PrivateAssets>
+        <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      </PackageReference>
+    </ItemGroup>
     
 </Project>
diff --git a/src/RazorHx/Results/RazorHxResult.cs b/src/RazorHx/Results/RazorHxResult.cs
@@ -1,14 +1,14 @@
 ﻿using Microsoft.AspNetCore.Components;
 using Microsoft.AspNetCore.Http;
+using RazorHx.Extensions;
+using RazorHx.Htmx;
 
 namespace RazorHx.Results;
 
 public class RazorHxResult : IResult, IStatusCodeHttpResult, IContentTypeHttpResult
 {
-    internal static readonly ParameterView EmptyParameters = ParameterView.Empty;
-
     protected RazorHxResult(Type componentType)
-        : this(componentType, EmptyParameters)
+        : this(componentType, ParameterView.Empty)
     {
     }
 
@@ -28,13 +28,14 @@ private RazorHxResult(Type componentType, ParameterView parameters)
     public string? ContentType { get; set; }
     public int? StatusCode { get; set; }
     public Type ComponentType { get; }
-    public Type? OobComponentType { get; protected set; }
+    public Type? OobComponentType { get; set; }
     public ParameterView Parameters { get; }
-    public ParameterView OobParameters { get; protected set; }
+    public ParameterView OobParameters { get; set; }
+    public List<HtmxTrigger> Triggers { get; } = [];
 
-    public Task ExecuteAsync(HttpContext httpContext)
+    public async Task ExecuteAsync(HttpContext httpContext)
     {
-        return RazorHxResultExecutor.ExecuteAsync(httpContext, this);
+        await RazorHxResultExecutor.ExecuteAsync(httpContext, this);
     }
 
     internal static ParameterView CoerceParametersObjectToDictionary(object? parameters)
diff --git a/src/RazorHx/Results/RazorHxResultExecutor.cs b/src/RazorHx/Results/RazorHxResultExecutor.cs
@@ -5,6 +5,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using RazorHx.Components;
 using RazorHx.DependencyInjection;
+using RazorHx.Htmx;
 using RazorHx.Htmx.HttpContextFeatures;
 
 namespace RazorHx.Results;
@@ -13,30 +14,16 @@ internal static class RazorHxResultExecutor
 {
     private const string DefaultContentType = "text/html; charset=utf-8";
 
-    public static Task ExecuteAsync(HttpContext httpContext, RazorHxResult result)
+    public static async Task ExecuteAsync(HttpContext httpContext, RazorHxResult result)
     {
         ArgumentNullException.ThrowIfNull(httpContext);
 
         var response = httpContext.Response;
         response.ContentType = result.ContentType ?? DefaultContentType;
+        response.StatusCode = result.StatusCode ?? response.StatusCode;
 
-        if (result.StatusCode != null) response.StatusCode = result.StatusCode.Value;
+        PrepareResponseHeaders(httpContext, result);
 
-        return RenderComponentToResponse(
-            httpContext,
-            result.ComponentType,
-            result.Parameters,
-            result.OobComponentType,
-            result.OobParameters);
-    }
-
-    private static async Task<Task> RenderComponentToResponse(
-        HttpContext httpContext,
-        Type componentType,
-        ParameterView componentParameters,
-        Type? oobComponentType,
-        ParameterView oobComponentParameters)
-    {
         var htmlRenderer = httpContext.RequestServices.GetRequiredService<HtmlRenderer>();
         var razorHxComponentsServiceOptions = httpContext.RequestServices.GetRequiredService<RazorHxServiceOptions>();
         var htmxRequestFeature = httpContext.Features.Get<IHtmxRequestFeature>();
@@ -52,23 +39,23 @@ private static async Task<Task> RenderComponentToResponse(
         }
         else
         {
-            var useComponentLayout = componentType.GetCustomAttribute<LayoutAttribute>() != null;
+            var useComponentLayout = result.ComponentType.GetCustomAttribute<LayoutAttribute>() != null;
             layout = useComponentLayout
-                ? componentType.GetCustomAttribute<LayoutAttribute>()!.LayoutType
+                ? result.ComponentType.GetCustomAttribute<LayoutAttribute>()!.LayoutType
                 : razorHxComponentsServiceOptions.RootComponent;
         }
 
         var parameters = new Dictionary<string, object?>
         {
             { "Layout", layout },
-            { "ComponentType", componentType },
-            { "Parameters", (Dictionary<string, object?>)componentParameters.ToDictionary() }
+            { "ComponentType", result.ComponentType },
+            { "Parameters", (Dictionary<string, object?>)result.Parameters.ToDictionary() }
         };
 
-        if (oobComponentType != null)
+        if (result.OobComponentType != null)
         {
-            parameters.Add("OobComponentType", oobComponentType);
-            parameters.Add("OobParameters", (Dictionary<string, object?>)oobComponentParameters.ToDictionary());
+            parameters.Add("OobComponentType", result.OobComponentType);
+            parameters.Add("OobParameters", (Dictionary<string, object?>)result.OobParameters.ToDictionary());
         }
 
         var htmlContent = await htmlRenderer.Dispatcher.InvokeAsync(async () =>
@@ -78,6 +65,41 @@ private static async Task<Task> RenderComponentToResponse(
             return output.ToHtmlString();
         });
 
-        return httpContext.Response.WriteAsync(htmlContent);
+        await httpContext.Response.WriteAsync(htmlContent);
+    }
+
+    private static void PrepareResponseHeaders(HttpContext httpContext, RazorHxResult result)
+    {
+        foreach (var trigger in result.Triggers)
+        {
+            switch (trigger.Timing)
+            {
+                case TriggerTiming.Default:
+                    SetHeader(HxResponseHeaderKeys.Trigger, trigger.Name);
+                    break;
+                case TriggerTiming.AfterSettle:
+                    SetHeader(HxResponseHeaderKeys.TriggerAfterSettle, trigger.Name);
+                    break;
+                case TriggerTiming.AfterSwap:
+                    SetHeader(HxResponseHeaderKeys.TriggerAfterSwap, trigger.Name);
+                    break;
+                default:
+                    throw new ArgumentOutOfRangeException();
+            }
+        }
+
+        return;
+
+        void SetHeader(string header, string trigger)
+        {
+            if (httpContext.Response.Headers.Remove(header, out var _))
+            {
+                httpContext.Response.Headers.Append(header, trigger);
+            }
+            else
+            {
+                httpContext.Response.Headers.Append(header, trigger);
+            }
+        }
     }
 }
diff --git a/src/RazorHx/Results/RazorHxResultExtensions.cs b/src/RazorHx/Results/RazorHxResultExtensions.cs
diff --git a/src/RazorHx/Results/RazorHxResultOfT.cs b/src/RazorHx/Results/RazorHxResultOfT.cs
diff --git a/src/RazorHx/version.json b/src/RazorHx/version.json

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`using System.ComponentModel;`
`2`	`2`
`3`		`-namespace RazorHx;`
	`3`	`+namespace RazorHx.Extensions;`
`4`	`4`
`5`		`-public static class ObjectExtensions`
	`5`	`+internal static class ObjectExtensions`
`6`	`6`	`{`
`7`	`7`	`public static Dictionary<string, object?> ToDictionary(this object? values)`
`8`	`8`	`{`