HtmlForgeX

API Reference

Class

TablerSidebarNavigationBuilder

Namespace HtmlForgeX
Assembly HtmlForgeX

Builder for the sidebar navigation component.

Inheritance

  • Object
  • TablerSidebarNavigationBuilder

Constructors

Methods

public TablerSidebarNavigationBuilder AddBottomItem(Action<TablerNavigationItemBuilder> config) #
Returns: TablerSidebarNavigationBuilder

Adds an item to the bottom of the sidebar.

Parameters

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

Adds a section divider.

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

Adds a navigation item to the sidebar.

Parameters

config System.Action{HtmlForgeX.TablerNavigationItemBuilder} requiredposition: 0
public TablerSidebarNavigationBuilder AddSection(String title) #
Returns: TablerSidebarNavigationBuilder

Adds a section title.

Parameters

title System.String requiredposition: 0
public TablerSidebarNavigationStructure Build() #
Returns: TablerSidebarNavigationStructure

Builds the sidebar navigation structure.

public TablerSidebarNavigationBuilder Collapsible(Boolean collapsible = true) #
Returns: TablerSidebarNavigationBuilder

Controls whether the sidebar is collapsible on mobile.

Parameters

collapsible System.Boolean = true optionalposition: 0
public TablerSidebarNavigationBuilder Dark(Boolean dark = true) #
Returns: TablerSidebarNavigationBuilder

Makes the sidebar dark themed.

Parameters

dark System.Boolean = true optionalposition: 0
public TablerSidebarNavigationBuilder RightSide(Boolean rightSide = true) #
Returns: TablerSidebarNavigationBuilder

Places the sidebar on the right side.

Parameters

rightSide System.Boolean = true optionalposition: 0
public TablerSidebarNavigationBuilder Transparent(Boolean transparent = true) #
Returns: TablerSidebarNavigationBuilder

Makes the sidebar transparent.

Parameters

transparent System.Boolean = true optionalposition: 0
public TablerSidebarNavigationBuilder Width(String cssWidth) #
Returns: TablerSidebarNavigationBuilder

Sets a custom CSS width for the sidebar shell.

Parameters

cssWidth System.String requiredposition: 0
public TablerSidebarNavigationBuilder WidthPreset(TablerSidebarWidthPreset preset) #
Returns: TablerSidebarNavigationBuilder

Sets the desktop width preset used by the sidebar.

Parameters

preset HtmlForgeX.TablerSidebarWidthPreset requiredposition: 0
public TablerSidebarNavigationBuilder WithBrand(String text, String subtitle = null) #
Returns: TablerSidebarNavigationBuilder

Sets the brand text for the sidebar.

Parameters

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

Sets the logo for the sidebar.

Parameters

path System.String requiredposition: 0
size HtmlForgeX.TablerLogoSize = Default optionalposition: 1