string? RequiresStream { get; set; }
Source
Gets or sets the name or identifier of the stream required by this element.
TagHelpers
RequiresStreamTagHelper
SourceA TagHelper that marks an element as requiring a specific Turbo Stream to be established before becoming active.
Process
void Process(TagHelperContext context, TagHelperOutput output)
Source
Applies stream-requirement attributes and disables the element when a requires-stream value is present.
Remarks
IfRequiresStream is null or whitespace, the output is left unchanged. Otherwise adds the following attributes to the element: data-rw-requires-streamset to theRequiresStreamvaluearia-disabledto"true"disabledto"disabled"(only for supported form elements)
RequiresStream
LocalTimeTagHelper
SourceTag helper that renders a <time> element with a UTC timestamp for client-side time formatting.
Remarks
When rw-type="local", the JavaScript runtime formats the timestamp to the user's local timezone. When rw-type="utc", the timestamp is formatted in UTC.
Example
<time rw-type="local" datetime="@Model.Timestamp"></time>
<time rw-type="local" datetime="@Model.Timestamp" rw-display="relative"></time>
<time rw-type="local" datetime="@Model.Timestamp" rw-display="datetime" rw-format="short"></time>
<time rw-type="utc" datetime="@Model.Timestamp"></time>Process
void Process(TagHelperContext context, TagHelperOutput output)
Source
Renders a <time> element with the UTC timestamp in the datetime attribute and data attributes for client-side JavaScript formatting.
Parameters
contextContains information associated with the current HTML tag.outputA stateful HTML element used to generate an HTML tag.
Exceptions
ArgumentExceptionThrown whenValueis the default value or ifDisplayorFormathave invalid values.
RwType
string? RwType { get; set; }
Source
Gets or sets the timezone type for RazorWire time formatting. Valid values: local (user's browser timezone) or utc (UTC timezone).
Value
DateTimeOffset Value { get; set; }
Source
The UTC timestamp to display, sourced from the datetime attribute.
Display
string Display { get; set; }
Source
Gets or sets the display mode for the formatted time. Valid values: time (default), date, datetime, or relative.
Format
string? Format { get; set; }
Source
Gets or sets the format style for absolute time formatting. Valid values: short, medium (default), long, or full.
RazorWireFormTagHelper
SourceA Tag Helper that enhances a standard <form> element with RazorWire/Turbo features.
Process
void Process(TagHelperContext context, TagHelperOutput output)
Source
Processes a form tag by removing attributes that start with "rw-" and configuring Turbo attributes based on the tag helper's properties.
Parameters
contextThe context for the current tag helper execution.outputThe tag helper output whose attributes will be modified.
Enabled
bool Enabled { get; set; }
Source
Gets or sets a value indicating whether RazorWire/Turbo enhancement is enabled for this form. Defaults to true.
TargetFrame
string? TargetFrame { get; set; }
Source
Gets or sets the identifier of the Turbo Frame that this form should target.
Antiforgery
string? Antiforgery { get; set; }
Source
Gets or sets the anti-forgery behavior assertion for this form.
Remarks
Supported values are lazy and off. lazy emits data-rw-antiforgery="lazy", asserting that the runtime should fetch a fresh anti-forgery token before the form is submitted. off emits data-rw-antiforgery="off", an explicit opt-out that the exporter treats as unsafe if a static token is still present. When this property is unset, normal server-rendered forms keep their default ASP.NET Core anti-forgery behavior, and hybrid export can still convert RazorWire-owned static token forms to lazy refresh.
AutoAssetVersioningTagHelper
SourceA TagHelper that automatically applies version hashing to script and link tags that reference local files, if the asp-append-version attribute is missing.
IsLocal
bool IsLocal(string? path)
Source
Determines if the provided path is a local path suitable for versioning.
Parameters
pathThe path to check.
Returns
true if the path is local (starts with '/' or '~') and is not protocol-relative; otherwise, false.
Remarks
Relative paths (e.g. "css/site.css") are excluded because they are ambiguous without knowing the current request path context, which complicates server-side resolution. Use root-relative ('/') or app-relative ('~') paths for automatic versioning.
ViewContext
ViewContext ViewContext { get; set; }
Source
Gets or sets the view context.
Remarks
This property is automatically set by the framework when the TagHelper is created.
IslandTagHelper
SourceA TagHelper that renders a Turbo Frame as a "RazorWire Island", enabling partial page updates and client-side module mounting.
Process
void Process(TagHelperContext context, TagHelperOutput output)
Source
Renders a <turbo-frame> element whose attributes are populated from the tag helper's properties.
Exceptions
ArgumentExceptionThrown whenIdis null, empty, or consists only of white-space characters.
Remarks
Validates that Id is not null, empty, or whitespace and sets attributes such as id, src, loading, data-turbo-permanent, data-rw-swr, style (view-transition-name), data-rw-export, and client-related data attributes when the corresponding properties are provided. The rendered frame always includes data-rw-island="true". The exporter treats that marker as the ownership signal for RazorWire-managed island frame URLs in hybrid output, so callers should not remove or override it when the frame should keep RazorWire island behavior.
Id
string Id { get; set; }
Source
The unique identifier for the island, which becomes the id of the rendered turbo-frame.
Src
string? Src { get; set; }
Source
The source URL for the turbo-frame content.
Loading
string? Loading { get; set; }
Source
The loading strategy for the turbo-frame (e.g., "eager", "lazy").
Permanent
bool Permanent { get; set; }
Source
If true, the rendered element will have the 'data-turbo-permanent' attribute.
Swr
bool Swr { get; set; }
Source
If true, enables Stale-While-Revalidate behavior via 'data-rw-swr'.
TransitionName
string? TransitionName { get; set; }
Source
The name for the CSS View Transition, applied as 'view-transition-name' in the style attribute.
Export
string? Export { get; set; }
Source
The name of the client-side module to export/expose.
ClientModule
string? ClientModule { get; set; }
Source
The client-side module specifier to mount on this island. Use a relative path, root-relative path, same-origin URL, explicit HTTPS URL, or bare import-map specifier; inline module content such as data URLs is rejected by the browser runtime.
ClientStrategy
string? ClientStrategy { get; set; }
Source
The mounting strategy for the client module (e.g., "load", "visible", "idle").
ClientProps
string? ClientProps { get; set; }
Source
Initial properties (JSON) to pass to the client module's mount function.
AuthViewTagHelper
SourceProjects a passive AppSurface auth result into one server-rendered RazorWire auth state.
Remarks
The helper evaluates a host-owned policy through IRazorWireAuthResultProvider and renders only the matching child slot. It never challenges, forbids, redirects, signs callers in or out, mutates cookies, chooses authentication schemes, or grants access. Protected endpoints and actions must still enforce host-owned auth.
Policy
string? Policy { get; set; }
Source
Gets or sets the host-owned policy name to project.
Resource
object? Resource { get; set; }
Source
Gets or sets an optional host-owned authorization resource.
IncludeDiagnostics
bool IncludeDiagnostics { get; set; }
Source
Gets or sets a value indicating whether safe policy and reason diagnostics should be emitted.
Remarks
Diagnostics are off by default so rendered HTML does not expose policy names, failure reasons, or setup details unless the host explicitly asks for them.
ViewContext
ViewContext ViewContext { get; set; }
Source
Gets or sets the current MVC view context.
AuthSlotContext
SourceCarries per-render slot resolution state for an rw:auth-view.
Remarks
Slot helpers mutate MatchedExplicitSlot during child-content execution. Static export reads that flag after slot resolution to decide whether a protected view supplied an explicit anonymous fallback before any artifact is written.
State
RazorWireAuthProjectionState State { get; }
Source
Gets the projected RazorWire auth state that slot helpers compare against.
MatchedExplicitSlot
bool MatchedExplicitSlot { get; set; }
Source
Gets or sets a value indicating whether an explicit slot matching State rendered.
Remarks
Only the slot resolution path should set this flag. It must be set before rw:auth-view evaluates the static-export missing-fallback check.
AuthAllowedSlotTagHelper
SourceRenders child content when the surrounding auth view is allowed.
AuthAnonymousSlotTagHelper
SourceRenders child content when the surrounding auth view requires authentication.
AuthForbiddenSlotTagHelper
SourceRenders child content when the surrounding auth view is forbidden.
AuthSetupFailureSlotTagHelper
SourceRenders child content when host auth setup is missing or failed.
AuthStaleSlotTagHelper
SourceRenders child content when the surrounding auth view has a stale or unknown session.
AuthUnknownSlotTagHelper
SourceRenders child content when the surrounding auth view has no evaluated result.
AuthGateTagHelper
SourceConditionally renders child content when the projected auth state matches.
Policy
string? Policy { get; set; }
Source
Gets or sets the host-owned policy name to project.
Resource
object? Resource { get; set; }
Source
Gets or sets an optional host-owned authorization resource.
State
string? State { get; set; }
Source
Gets or sets the state that should render the child content. Defaults to allowed.
IncludeDiagnostics
bool IncludeDiagnostics { get; set; }
Source
Gets or sets a value indicating whether safe policy and reason diagnostics should be emitted.
ViewContext
ViewContext ViewContext { get; set; }
Source
Gets or sets the current MVC view context.
HelperName
string HelperName { get; }
Source
Gets the helper name emitted in data-rw-auth-helper.
TargetState
RazorWireAuthProjectionState TargetState { get; }
Source
Gets the projected state required for rendering.
PermissionGateTagHelper
SourceAlias over AuthGateTagHelper for policy-oriented allowed-state rendering.
State
string? State { get; set; }
Source
Hides the general gate state selector because permission gates are allowed-only aliases.
LoginLinkTagHelper
SourceRenders a host-owned login link without initiating authentication.
Remarks
The helper emits a normal anchor. The host owns the target URL and authentication behavior.
Href
string? Href { get; set; }
Source
Gets or sets the host-owned login URL.
ReturnUrlPolicy
string? ReturnUrlPolicy { get; set; }
Source
Gets or sets the return-url policy. Use current-path to append the current local path as returnUrl.
ViewContext
ViewContext ViewContext { get; set; }
Source
Gets or sets the current MVC view context.
LogoutButtonTagHelper
SourceRenders a host-owned logout form without signing callers out.
Action
string? Action { get; set; }
Source
Gets or sets the host-owned logout form action.
ReturnUrlPolicy
string? ReturnUrlPolicy { get; set; }
Source
Gets or sets the return-url policy. Use current-path to include the current local path as a hidden returnUrl input.
ViewContext
ViewContext ViewContext { get; set; }
Source
Gets or sets the current MVC view context.
AuthSlotTagHelper
SourceBase class for auth-view slot helpers.
State
RazorWireAuthProjectionState State { get; }
Source
Gets the state that renders this slot.
FormToggleTagHelper
SourceMarks an application-authored form control as a RazorWire conditional form toggle.
Remarks
Use this helper when Razor markup should normalize to the canonical data-rw-form-toggle attribute. RazorWire interprets null, blank, true, and the sentinel rw-form-toggle value as the default logical name true. When applied to a button, the helper sets type="button" when the app has not supplied a type so toggles do not submit forms by default. The helper does not move focus, validate business rules, or generate target markup; the app owns the control and target.
TargetName
string? TargetName { get; set; }
Source
Gets or sets the logical target name this control toggles.
Remarks
Values are trimmed. Blank, true, and rw-form-toggle normalize to true so attribute-only Razor usage has a stable default name.
Invert
bool Invert { get; set; }
Source
Gets or sets a value indicating whether the control's active state should be inverted.
Remarks
The default is false. Set this for controls such as "no action expected" checkboxes where the checked state should hide the target instead of showing it.
FormToggleTargetTagHelper
SourceMarks an application-authored element as the target controlled by a RazorWire conditional form toggle.
Remarks
The helper emits only data-rw-form-toggle-target metadata. Target contents, model fields, validation messages, and layout remain app-owned. Null, blank, true, and rw-form-toggle-target normalize to the default logical name true.
TargetName
string? TargetName { get; set; }
Source
Gets or sets the logical toggle name that controls this target.
Remarks
Values are trimmed and normalized to true for attribute-only usage. The value must match the toggle name inside the same form.
DisableWhenHidden
bool DisableWhenHidden { get; set; }
Source
Gets or sets a value indicating whether descendant controls should be disabled while the target is hidden.
Remarks
The default is false. When enabled, RazorWire disables only controls it owns during the hidden state and restores only those controls when the target is shown again.
FormCollectionTagHelper
SourceMarks an application-authored element as a one-dimensional model-bound collection root.
Remarks
The collection root scopes row commands, templates, sparse index markers, and diagnostics for one ASP.NET Core collection property. RazorWire stable v1 intentionally does not support nested collections, reordering, generated model fields, or app persistence decisions.
Name
string? Name { get; set; }
Source
Gets or sets the ASP.NET Core model property name for the collection, such as Actions.
Remarks
The value is trimmed and emitted as data-rw-form-collection. It must match the prefix used by app-authored field names and hidden .index markers.
Label
string? Label { get; set; }
Source
Gets or sets optional reader-facing copy for generated announcements.
Remarks
The value is used only for local status messages such as add, duplicate, and remove announcements. It does not change model binding names.
RemoveMode
string? RemoveMode { get; set; }
Source
Gets or sets the default remove mode for row commands inside this collection.
Remarks
Values are passed through after trimming. The runtime recognizes mark and mark-remove as mark-for-removal; other values fall back to physical remove behavior.
FormCollectionRowTagHelper
SourceMarks an application-authored element as a row inside a RazorWire form collection.
Remarks
Rows must contain app-owned hidden Collection.index markers for ASP.NET Core sparse collection binding. The helper marks the row and may emit the optional current index, but it does not create hidden markers or generated input fields.
Index
string? Index { get; set; }
Source
Gets or sets the row's current model-binding index.
Remarks
When provided, the trimmed value is emitted as data-rw-form-index. Keep it aligned with the row's enabled hidden .index marker.
FormCollectionTemplateTagHelper
SourceMarks a template containing app-authored collection row markup.
Remarks
The template must contain the literal __index__ token in row field names, ids, label references, validation references, and the hidden .index value. RazorWire clones and rewrites this markup but does not invent app fields.
FormCollectionAddTagHelper
SourceMarks a button that adds a row from the nearest collection template.
Remarks
The helper emits data-rw-form-collection-add and sets type="button" when the app has not supplied a type. The nearest collection root and template determine what row is inserted.
FormCollectionDuplicateTagHelper
SourceMarks a button that duplicates the nearest collection row.
Remarks
The helper emits data-rw-form-collection-duplicate and sets type="button" when absent. Duplicate requires the source row to have a resolvable sparse index so names, ids, labels, and validation references can be rewritten safely.
FormCollectionRemoveTagHelper
SourceMarks a button that removes or marks the nearest collection row.
Remarks
Use physical remove for draft-only rows whose absence from the payload is enough. Use mark-for-removal for persisted rows when the app provides hidden id/delete fields and server-side delete semantics. The helper never creates those app-owned persistence fields.
Mode
string? Mode { get; set; }
Source
Gets or sets the remove mode for this command: physical or mark.
Remarks
Null, blank, true, and rw-form-collection-remove normalize to physical. The runtime also accepts mark-remove as a mark-for-removal command value.
StreamSourceTagHelper
SourceTag helper that renders an rw-stream-source element to establish a connection to a RazorWire stream.
Process
void Process(TagHelperContext context, TagHelperOutput output)
Source
Configures the rw-stream-source element by setting its src attribute and handling the permanent option.
Parameters
contextContains information associated with the current HTML tag.outputA stateful HTML element used to generate an HTML tag.
Exceptions
InvalidOperationExceptionThrown whenChannelis null, empty, or contains only whitespace.
Channel
string Channel { get; set; }
Source
Gets or sets the channel name of the stream to connect to. This attribute is required.
Permanent
bool Permanent { get; set; }
Source
Gets or sets a value indicating whether the stream source should be preserved across Turbo page loads.
Replay
bool Replay { get; set; }
Source
Gets or sets a value indicating whether retained channel messages should be delivered before live messages.
Remarks
The default is false. When Replay is true, StreamSourceTagHelper appends ?replay=1 to the generated stream URL so MapRazorWire can request retained messages before live delivery. Use replay for clients that need recent context before subscribing to new events. Replay can increase initial latency and bandwidth, may duplicate messages a client already processed before reconnecting, and depends on the hub implementation's retention policy.
RazorWireScriptsTagHelper
SourceTag helper for rendering the necessary RazorWire scripts.
Process
void Process(TagHelperContext context, TagHelperOutput output)
Source
Renders the client-side script tags required by RazorWire and removes the wrapper element so no enclosing tag is emitted.
Parameters
contextThe current tag helper context.outputThe tag helper output that will be modified to contain the script elements and have no wrapper tag.
Exceptions
InvalidOperationExceptionThrown whenRazorWireOptions.Hybrid.RazorWireHybridOptions.LiveOriginis not an absolute HTTP(S) origin or includes a path, query string, fragment, or userinfo.
Remarks
The generated runtime script includes data attributes for form failure UX, development diagnostics, split-origin live origin, hybrid credential behavior, and the lazy anti-forgery token endpoint. The helper normalizes RazorWireOptions.Hybrid.RazorWireHybridOptions.LiveOrigin before emitting it so the browser receives only an origin, never a path-bearing URL. The anti-forgery endpoint is emitted relative to the current request path base so applications mounted under a virtual directory refresh tokens from the live app path. Use RazorWireHybridCredentialsMode.Auto to include credentials automatically when a live origin is configured; use explicit include or omit only when the live endpoint contract requires it.
ViewContext
ViewContext ViewContext { get; set; }
Source
Gets or sets the view context.
SectionCopy
bool SectionCopy { get; set; }
Source
Gets or sets a value indicating whether the section-copy runtime should be eagerly rendered after the core runtime.
Remarks
Section copy is split out of the core runtime so plain RazorWire pages do not pay for clipboard behavior they do not use. Plain <rw:scripts /> emits a small usage detector that loads the runtime only when the rendered page contains data-rw-section-copy or data-rw-section-copy-target markup. Set this attribute to true when a host wants to eagerly fetch the section-copy asset before the detector runs.
FormInteractions
bool FormInteractions { get; set; }
Source
Gets or sets a value indicating whether the form-interactions runtime should be eagerly rendered after the core runtime.
Remarks
Form interactions are split out of the core runtime so plain RazorWire pages do not pay for local form mechanics they do not use. Plain <rw:scripts /> emits a small usage detector that loads the runtime only when the rendered page contains data-rw-form-toggle or data-rw-form-collection markup. Set this attribute to true when a host wants to eagerly fetch the form-interactions asset before the detector runs.
BehaviorKit
bool BehaviorKit { get; set; }
Source
Gets or sets a value indicating whether the Behavior Kit runtime should be eagerly rendered after the core runtime.
Remarks
Behavior Kit is explicit in v1 because app-owned behavior registrations need a predictable public API surface. Plain <rw:scripts /> does not lazy-load it from markup. Set this attribute to true when a host wants window.RazorWire.behaviors to connect root-scoped behaviors or page-lifecycle registrations.