Class HtmxScriptsTagHelper

Namespace

Htmx.Components.TagHelpers

Assembly

Htmx.Components.dll

Tag helper that includes all Htmx.Components JavaScript behaviors as inline scripts. This replaces the need to include individual JavaScript files and allows for dynamic content generation.

[HtmlTargetElement("htmx-scripts")]
public class HtmxScriptsTagHelper : TagHelper, ITagHelper, ITagHelperComponent

Inheritance

object

TagHelper

HtmxScriptsTagHelper

Implements

ITagHelper

ITagHelperComponent

Inherited Members

TagHelper.Init(TagHelperContext)

TagHelper.Process(TagHelperContext, TagHelperOutput)

TagHelper.Order

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

StringExtensions.ConvertToInputString<T>(T)

Constructors

HtmxScriptsTagHelper(IHtmlHelper, IWebHostEnvironment)

Initializes a new instance of the HtmxScriptsTagHelper with the required dependencies.

public HtmxScriptsTagHelper(IHtmlHelper htmlHelper, IWebHostEnvironment environment)

Parameters

htmlHelper IHtmlHelper

The HTML helper for rendering HTML content

environment IWebHostEnvironment

The web hosting environment for accessing application information

Properties

Exclude

Gets or sets which scripts to exclude from the default set. Valid values: "page-state-headers", "table-inline-editing", "blur-save-coordination", "authentication-retry"

public string? Exclude { get; set; }

Property Value

string

Include

Gets or sets which scripts to include. If null or empty, includes all scripts. Valid values: "page-state-headers", "table-inline-editing", "blur-save-coordination", "authentication-retry"

public string? Include { get; set; }

Property Value

string

ViewContext

ViewContext is required to contextualize the IHtmlHelper

[ViewContext]
[HtmlAttributeNotBound]
public ViewContext ViewContext { get; set; }

Property Value

ViewContext

Methods

ProcessAsync(TagHelperContext, TagHelperOutput)

Processes the tag helper and renders the requested JavaScript behaviors.

public override Task ProcessAsync(TagHelperContext context, TagHelperOutput output)

Parameters

context TagHelperContext

output TagHelperOutput

Returns

Task