HtmlForgeX

API Reference

Class

TablerHeaderNavbarBuilder

Namespace HtmlForgeX
Assembly HtmlForgeX

Builder for the header navbar component.

Inheritance

  • Object
  • TablerHeaderNavbarBuilder

Constructors

Methods

public TablerHeaderNavbarBuilder AddItem(Action<TablerNavigationItemBuilder> config) #
Returns: TablerHeaderNavbarBuilder

Adds a navigation item to the header.

Parameters

config System.Action{HtmlForgeX.TablerNavigationItemBuilder} requiredposition: 0
public TablerHeaderNavbarBuilder AddRightItem(Action<TablerNavigationItemBuilder> config) #
Returns: TablerHeaderNavbarBuilder

Adds a right-aligned item to the header.

Parameters

config System.Action{HtmlForgeX.TablerNavigationItemBuilder} requiredposition: 0
public TablerHeaderNavbarBuilder BrandPlacement(TablerNavbarBrandPlacement placement) #
Returns: TablerHeaderNavbarBuilder

Controls where the brand/logo block sits within the header.

Parameters

placement HtmlForgeX.TablerNavbarBrandPlacement requiredposition: 0
public TablerHeaderNavbarStructure Build() #
Returns: TablerHeaderNavbarStructure

Builds the header navbar structure.

public TablerHeaderNavbarBuilder Chrome(TablerHeaderChrome chrome) #
Returns: TablerHeaderNavbarBuilder

Sets the visual chrome used by the top header shell.

Parameters

chrome HtmlForgeX.TablerHeaderChrome requiredposition: 0
public TablerHeaderNavbarBuilder Dark(Boolean dark = true) #
Returns: TablerHeaderNavbarBuilder

Makes the header dark themed.

Parameters

dark System.Boolean = true optionalposition: 0
public TablerHeaderNavbarBuilder ExpandAt(TablerNavigationExpand expand) #
Returns: TablerHeaderNavbarBuilder

Sets when the navigation should expand.

Parameters

expand HtmlForgeX.TablerNavigationExpand requiredposition: 0
public TablerHeaderNavbarBuilder FrostMode(TablerHorizontalFrostMode frostMode) #
Returns: TablerHeaderNavbarBuilder

Controls whether horizontal shells use stronger glowing panels or a quieter unified frost treatment.

Parameters

frostMode HtmlForgeX.TablerHorizontalFrostMode requiredposition: 0
public TablerHeaderNavbarBuilder Overlap(Boolean overlap = true) #
Returns: TablerHeaderNavbarBuilder

Makes the header overlap the content below.

Parameters

overlap System.Boolean = true optionalposition: 0
public TablerHeaderNavbarBuilder ShowBrand(Boolean showBrand = true) #
Returns: TablerHeaderNavbarBuilder

Controls whether the shared header brand block is rendered.

Parameters

showBrand System.Boolean = true optionalposition: 0
public TablerHeaderNavbarBuilder SidebarIntegration(TablerHeaderSidebarIntegration integration) #
Returns: TablerHeaderNavbarBuilder
EditorBrowsable(2)

Controls whether a two-stage header docks to the sidebar edge or spans across its lane on desktop.

Parameters

integration HtmlForgeX.TablerHeaderSidebarIntegration requiredposition: 0
public TablerHeaderNavbarBuilder Sticky(Boolean sticky = true) #
Returns: TablerHeaderNavbarBuilder

Makes the header sticky on scroll.

Parameters

sticky System.Boolean = true optionalposition: 0
public TablerHeaderNavbarBuilder UtilityPlacement(TablerNavbarUtilityPlacement placement) #
Returns: TablerHeaderNavbarBuilder

Controls where utility controls sit within the header.

Parameters

placement HtmlForgeX.TablerNavbarUtilityPlacement requiredposition: 0
public TablerHeaderNavbarBuilder WithBrand(String text, String subtitle = null) #
Returns: TablerHeaderNavbarBuilder

Sets the brand text for the header.

Parameters

text System.String requiredposition: 0
subtitle System.String = null optionalposition: 1
public TablerHeaderNavbarBuilder WithLogo(String path, TablerLogoSize size = Default) #
Returns: TablerHeaderNavbarBuilder

Sets the logo for the header.

Parameters

path System.String requiredposition: 0
size HtmlForgeX.TablerLogoSize = Default optionalposition: 1
public TablerHeaderNavbarBuilder WrapMode(TablerNavbarWrapMode wrapMode) #
Returns: TablerHeaderNavbarBuilder

Controls whether the header stays on a single row or intentionally wraps.

Parameters

wrapMode HtmlForgeX.TablerNavbarWrapMode requiredposition: 0