HtmlForgeX

API Reference

Class

TablerNavigationItemBuilder

Namespace HtmlForgeX
Assembly HtmlForgeX

Builder for individual navigation items.

Inheritance

  • Object
  • TablerNavigationItemBuilder

Constructors

Methods

public TablerNavigationItemBuilder Active(Boolean active = true) #
Returns: TablerNavigationItemBuilder

Marks the item as active.

Parameters

active System.Boolean = true optionalposition: 0
AddApp 2 overloads
public TablerNavigationItemBuilder AddApp(String name, String iconUrl, String href = null) #
Returns: TablerNavigationItemBuilder

Adds an app to the app menu dropdown.

Parameters

name System.String requiredposition: 0
iconUrl System.String requiredposition: 1
href System.String = null optionalposition: 2
public TablerNavigationItemBuilder AddApp(Action<TablerAppMenuItem> configure) #
Returns: TablerNavigationItemBuilder

Adds an app to the app menu dropdown with configuration.

Parameters

configure System.Action{HtmlForgeX.TablerAppMenuItem} requiredposition: 0
public TablerNavigationItemBuilder AddChild(Action<TablerNavigationItemBuilder> config) #
Returns: TablerNavigationItemBuilder

Adds a child item (for dropdowns).

Parameters

config System.Action{HtmlForgeX.TablerNavigationItemBuilder} requiredposition: 0
public TablerNavigationItemBuilder AddDivider() #
Returns: TablerNavigationItemBuilder

Adds a divider to the dropdown.

public TablerNavigationItemBuilder AddHeader(String text) #
Returns: TablerNavigationItemBuilder

Adds a non-clickable header inside the dropdown menu.

Parameters

text System.String requiredposition: 0
public TablerNavigationItemBuilder AsAppMenuDropdown(String title = "My Apps", String settingsHref = null) #
Returns: TablerNavigationItemBuilder

Marks this as an app menu dropdown (grid of apps).

Parameters

title System.String = "My Apps" optionalposition: 0
Title shown in the dropdown header (also used as aria-label).
settingsHref System.String = null optionalposition: 1
Optional settings link shown as a gear icon in the dropdown header.
public TablerNavigationItemBuilder AsDarkModeToggle() #
Returns: TablerNavigationItemBuilder

Marks this as a dark mode toggle.

public TablerNavigationItemBuilder AsNotificationDropdown() #
Returns: TablerNavigationItemBuilder

Marks this as a notification dropdown.

public TablerNavigationItemBuilder AsUserMenu(String avatarUrl = null) #
Returns: TablerNavigationItemBuilder

Marks this as a user menu dropdown.

Parameters

avatarUrl System.String = null optionalposition: 0
public TablerNavigationItemBuilder AutoColumns(Int32 threshold = 10) #
Returns: TablerNavigationItemBuilder

Enables auto columnization for this dropdown with a custom threshold. When item count >= threshold, columns are used.

Parameters

threshold System.Int32 = 10 optionalposition: 0
public TablerNavigationItemConfig Build() #
Returns: TablerNavigationItemConfig

Builds the navigation item configuration.

Returns

A populated TablerNavigationItemConfig instance.

public TablerNavigationItemBuilder Disabled(Boolean disabled = true) #
Returns: TablerNavigationItemBuilder

Marks the item as disabled.

Parameters

disabled System.Boolean = true optionalposition: 0
public TablerNavigationItemBuilder ToPage(String pageId) #
Returns: TablerNavigationItemBuilder

Links to a page in the multi-page application.

Parameters

pageId System.String requiredposition: 0
public TablerNavigationItemBuilder UseColumns(Int32 columns) #
Returns: TablerNavigationItemBuilder

Forces a fixed number of columns for this dropdown (top-level menu).

Parameters

columns System.Int32 requiredposition: 0
public TablerNavigationItemBuilder WithBadge(String text, Nullable<TablerColor> color = null) #
Returns: TablerNavigationItemBuilder

Adds a badge to the item.

Parameters

text System.String requiredposition: 0
color System.Nullable{HtmlForgeX.TablerColor} = null optionalposition: 1
public TablerNavigationItemBuilder WithDescription(String description) #
Returns: TablerNavigationItemBuilder

Sets a description for the item.

Parameters

description System.String requiredposition: 0
public TablerNavigationItemBuilder WithHref(String href) #
Returns: TablerNavigationItemBuilder

Sets a custom href.

Parameters

href System.String requiredposition: 0
public TablerNavigationItemBuilder WithIcon(TablerIconType icon, Nullable<TablerColor> color = null) #
Returns: TablerNavigationItemBuilder

Sets the item icon.

Parameters

icon HtmlForgeX.TablerIconType requiredposition: 0
color System.Nullable{HtmlForgeX.TablerColor} = null optionalposition: 1
public TablerNavigationItemBuilder WithText(String text) #
Returns: TablerNavigationItemBuilder

Sets the item text.

Parameters

text System.String requiredposition: 0