API Reference
Class
TablerNavigationItemBuilder
Builder for individual navigation items.
Inheritance
- Object
- TablerNavigationItemBuilder
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method TablerNavigationItemBuilder.Active
- Method TablerNavigationItemBuilder.AddApp
- Method TablerNavigationItemBuilder.AddApp
- Method TablerNavigationItemBuilder.AddChild
- Method TablerNavigationItemBuilder.AddDivider
- Method TablerNavigationItemBuilder.AddHeader
- Method TablerNavigationItemBuilder.AsAppMenuDropdown
- Method TablerNavigationItemBuilder.AsDarkModeToggle
- Method TablerNavigationItemBuilder.AsNotificationDropdown
- Method TablerNavigationItemBuilder.AsUserMenu
- Method TablerNavigationItemBuilder.AutoColumns
- Method TablerNavigationItemBuilder.Disabled
- Method TablerNavigationItemBuilder.ToPage
- Method TablerNavigationItemBuilder.UseColumns
- Method TablerNavigationItemBuilder.WithBadge
- Method TablerNavigationItemBuilder.WithDescription
- Method TablerNavigationItemBuilder.WithHref
- Method TablerNavigationItemBuilder.WithIcon
- Method TablerNavigationItemBuilder.WithText
Accepted by parameters
- Method TablerHeaderNavbarBuilder.AddItem
- Method TablerHeaderNavbarBuilder.AddRightItem
- Method TablerNavigationBuilder.AddItem
- Method TablerNavigationBuilder.AddRightItem
- Method TablerNavigationItemBuilder.AddChild
- Method TablerSidebarNavigationBuilder.AddBottomItem
- Method TablerSidebarNavigationBuilder.AddItem
Constructors
public TablerNavigationItemBuilder() #Methods
public TablerNavigationItemBuilder Active(Boolean active = true) #Returns:
TablerNavigationItemBuilderMarks the item as active.
Parameters
- active System.Boolean = true
AddApp 2 overloads
public TablerNavigationItemBuilder AddApp(String name, String iconUrl, String href = null) #Returns:
TablerNavigationItemBuilderAdds an app to the app menu dropdown.
Parameters
- name System.String
- iconUrl System.String
- href System.String = null
public TablerNavigationItemBuilder AddDivider() #Returns:
TablerNavigationItemBuilderAdds a divider to the dropdown.
public TablerNavigationItemBuilder AddHeader(String text) #Returns:
TablerNavigationItemBuilderAdds a non-clickable header inside the dropdown menu.
Parameters
- text System.String
public TablerNavigationItemBuilder AsDarkModeToggle() #Returns:
TablerNavigationItemBuilderMarks this as a dark mode toggle.
public TablerNavigationItemBuilder AsNotificationDropdown() #Returns:
TablerNavigationItemBuilderMarks this as a notification dropdown.
public TablerNavigationItemBuilder AutoColumns(Int32 threshold = 10) #Returns:
TablerNavigationItemBuilderEnables auto columnization for this dropdown with a custom threshold. When item count >= threshold, columns are used.
Parameters
- threshold System.Int32 = 10
public TablerNavigationItemConfig Build() #Returns:
TablerNavigationItemConfigBuilds the navigation item configuration.
Returns
A populated TablerNavigationItemConfig instance.
public TablerNavigationItemBuilder Disabled(Boolean disabled = true) #Returns:
TablerNavigationItemBuilderMarks the item as disabled.
Parameters
- disabled System.Boolean = true
public TablerNavigationItemBuilder ToPage(String pageId) #Returns:
TablerNavigationItemBuilderLinks to a page in the multi-page application.
Parameters
- pageId System.String
public TablerNavigationItemBuilder UseColumns(Int32 columns) #Returns:
TablerNavigationItemBuilderForces a fixed number of columns for this dropdown (top-level menu).
Parameters
- columns System.Int32
public TablerNavigationItemBuilder WithBadge(String text, Nullable<TablerColor> color = null) #Returns:
TablerNavigationItemBuilderAdds a badge to the item.
Parameters
- text System.String
- color System.Nullable{HtmlForgeX.TablerColor} = null
public TablerNavigationItemBuilder WithDescription(String description) #Returns:
TablerNavigationItemBuilderSets a description for the item.
Parameters
- description System.String
public TablerNavigationItemBuilder WithHref(String href) #Returns:
TablerNavigationItemBuilderSets a custom href.
Parameters
- href System.String
public TablerNavigationItemBuilder WithIcon(TablerIconType icon, Nullable<TablerColor> color = null) #Returns:
TablerNavigationItemBuilderSets the item icon.
Parameters
- icon HtmlForgeX.TablerIconType
- color System.Nullable{HtmlForgeX.TablerColor} = null
public TablerNavigationItemBuilder WithText(String text) #Returns:
TablerNavigationItemBuilderSets the item text.
Parameters
- text System.String