Skip to content

http: make the HtmxLocationOptions dictionaries read-only #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rameel merged 1 commit into from
Nov 2, 2026
Merged

http: make the HtmxLocationOptions dictionaries read-only #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/articles/migrate-to-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,8 +408,8 @@ See [History updates](responses.md#history-updates).
| `Target` | `Target` |
| `Swap` | `Swap` for a swap style; `SwapExpression` for a style with modifiers |
| `Select` | `Select` |
| `Values` (`object`) | `Values` (`IDictionary<string, HtmxFieldValues>`) |
| `Headers` (`object`) | `Headers` (`IDictionary<string, string>`) |
| `Values` (`object`) | `Values` (`IReadOnlyDictionary<string, HtmxFieldValues>`) |
| `Headers` (`object`) | `Headers` (`IReadOnlyDictionary<string, string>`) |
| `Event`, `Handler` | Removed: HTMX expects a live browser event and a JavaScript function, which JSON cannot carry |
| — | New: `SelectOob`, `HistoryUrl`, `HistoryAction` |

Expand Down
4 changes: 2 additions & 2 deletions src/Ramstack.HtmxToolkit/HtmxLocationOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public HtmxSwap? Swap
/// HTMX 4.0.0 converts an array to a single comma-separated field value.
/// </para>
/// </remarks>
public IDictionary<string, HtmxFieldValues>? Values { get; set; }
public IReadOnlyDictionary<string, HtmxFieldValues>? Values { get; set; }

/// <summary>
/// Gets or sets the headers to include with the request.
Expand All @@ -66,7 +66,7 @@ public HtmxSwap? Swap
/// Pass complex data as a pre-serialized JSON string.
/// </para>
/// </remarks>
public IDictionary<string, string>? Headers { get; set; }
public IReadOnlyDictionary<string, string>? Headers { get; set; }

/// <summary>
/// Gets or sets a CSS selector used to filter the content to swap from the response.
Expand Down
4 changes: 2 additions & 2 deletions src/Ramstack.HtmxToolkit/Serialization/HtmxLocationOptionsJsonView.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ internal readonly struct HtmxLocationOptionsJsonView(string path, HtmxLocationOp
/// <summary>
/// Gets the form field values.
/// </summary>
public IDictionary<string, HtmxFieldValues>? Values => options.Values;
public IReadOnlyDictionary<string, HtmxFieldValues>? Values => options.Values;

/// <summary>
/// Gets the request headers.
/// </summary>
public IDictionary<string, string>? Headers => options.Headers;
public IReadOnlyDictionary<string, string>? Headers => options.Headers;

/// <summary>
/// Gets the content selector.
Expand Down
Loading