Class NavBarViewComponent

Namespace

Htmx.Components.NavBar

Assembly

Htmx.Components.dll

View component that renders the navigation bar using the configured navigation provider.

public class NavBarViewComponent : ViewComponent

Inheritance

object

ViewComponent

NavBarViewComponent

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 delegates to the registered INavProvider to build the navigation structure and then renders it using the configured view. The navigation is automatically filtered based on the current user's permissions.

Constructors

NavBarViewComponent(INavProvider, ViewPaths)

Initializes a new instance of the NavBarViewComponent class.

public NavBarViewComponent(INavProvider navProvider, ViewPaths viewPaths)

Parameters

navProvider INavProvider

The navigation provider that builds the navigation structure.

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 the navigation bar.

public Task<IViewComponentResult> InvokeAsync()

Returns

Task<IViewComponentResult>

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