Class AuthStatusViewComponent

Namespace

Htmx.Components.AuthStatus

Assembly

Htmx.Components.dll

View component that renders authentication status information for the current user.

public class AuthStatusViewComponent : ViewComponent

Inheritance

object

ViewComponent

AuthStatusViewComponent

Inherited Members

ViewComponent.Content(string)

ViewComponent.View()

ViewComponent.View(string)

ViewComponent.View<TModel>(TModel)

ViewComponent.View<TModel>(string, TModel)

ViewComponent.HttpContext

ViewComponent.Request

ViewComponent.User

ViewComponent.UserClaimsPrincipal

ViewComponent.RouteData

ViewComponent.ViewBag

ViewComponent.ModelState

ViewComponent.Url

ViewComponent.ViewComponentContext

ViewComponent.ViewContext

ViewComponent.ViewData

ViewComponent.TempData

ViewComponent.ViewEngine

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)

Remarks

This component displays different content based on whether the user is authenticated, including user information, profile images, and login/logout links. The actual content and behavior are determined by the registered IAuthStatusProvider.

Constructors

AuthStatusViewComponent(IAuthStatusProvider, ViewPaths)

Initializes a new instance of the AuthStatusViewComponent class.

public AuthStatusViewComponent(IAuthStatusProvider authStatusProvider, ViewPaths viewPaths)

Parameters

authStatusProvider IAuthStatusProvider

The provider that generates authentication status data.

viewPaths ViewPaths

The configured view paths for rendering components.

Exceptions

ArgumentNullException

Thrown when any parameter is null.

Methods

InvokeAsync()

Invokes the view component to render authentication status.

public Task<IViewComponentResult> InvokeAsync()

Returns

Task<IViewComponentResult>

A task that represents the asynchronous operation. The task result contains the view component result.