Table of Contents

API reference

Find types by the task you want to perform. Each API page lists its members, accepted values, and remarks; the guides show how those pieces fit into an application.

Task Main types Guide
Detect HTMX requests and read headers HttpRequestExtensions, HtmxRequestHeaders Requests
Set response headers, navigation, and events HttpResponseExtensions, HtmxResponse, HtmxResponseHeaders Responses
Set swap styles, event timing, or a follow-up request HtmxSwap, HtmxTriggerTiming, HtmxLocationOptions Response instructions
Select or configure MVC actions HtmxRequestAttribute, HtmxResponseAttribute MVC action selection
Generate URLs in Razor HtmxUrlTagHelper Request URLs
Add values, headers, or request options HtmxValsTagHelper, HtmxHeaderTagHelper, HtmxRequestTagHelper Tag Helpers
Register the toolkit and render configuration ServiceCollectionExtensions, HtmxToolkitOptions, HtmxConfigTagHelper Configuration
Configure a specific HTMX version HtmxV1Config, HtmxV2Config, HtmxV4Config Choose a version

New to the library? Start with Getting started for a working Razor Pages application, or choose the MVC or Minimal API example.

This reference is generated from the public API and XML documentation comments in Ramstack.HtmxToolkit.