HtmlForgeX

API Reference

Class

TablerHeader

Namespace HtmlForgeX
Assembly HtmlForgeX
Base Element
Attributes
EditorBrowsable(2)

Tabler header/navbar component for professional navigation

Inheritance

Constructors

public TablerHeader() #

Initializes a new instance of the TablerHeader class

Methods

Action 2 overloads
public TablerHeader Action(String text, String href, TablerButtonVariant variant = Primary) #
Returns: TablerHeader

Add header action button

Parameters

text System.String requiredposition: 0
href System.String requiredposition: 1
variant HtmlForgeX.TablerButtonVariant = Primary optionalposition: 2
public TablerHeader Action(String text, String href, TablerIconType icon, TablerButtonVariant variant = Primary) #
Returns: TablerHeader

Add header action button with icon

Parameters

text System.String requiredposition: 0
href System.String requiredposition: 1
icon HtmlForgeX.TablerIconType requiredposition: 2
variant HtmlForgeX.TablerButtonVariant = Primary optionalposition: 3
public TablerHeader AppMenu(Boolean enable = true) #
Returns: TablerHeader

Enable app menu dropdown

Parameters

enable System.Boolean = true optionalposition: 0
public TablerHeader AppMenuItem(String name, String iconUrl, String href = null) #
Returns: TablerHeader

Add app menu item

Parameters

name System.String requiredposition: 0
iconUrl System.String requiredposition: 1
href System.String = null optionalposition: 2
public TablerHeader AutoHide(Boolean autoHide = true) #
Returns: TablerHeader

Enable auto-hide on scroll

Parameters

autoHide System.Boolean = true optionalposition: 0
public TablerHeader Brand(String text, String url = ".") #
Returns: TablerHeader

Set brand text and URL

Parameters

text System.String requiredposition: 0
url System.String = "." optionalposition: 1
public TablerHeader Chrome(TablerHeaderChrome chrome) #
Returns: TablerHeader

Sets the shared visual chrome used by the header shell.

Parameters

chrome HtmlForgeX.TablerHeaderChrome requiredposition: 0
public static TablerHeader Create(Action<TablerHeader> configure) #
Returns: TablerHeader

Create header with fluent configuration

Parameters

configure System.Action{HtmlForgeX.TablerHeader} requiredposition: 0
public TablerHeader DarkModeToggle(Boolean enable = true) #
Returns: TablerHeader

Enable/disable dark mode toggle

Parameters

enable System.Boolean = true optionalposition: 0
GetInitials(System.String name) #

Extracts initials from a full name

Parameters

name System.String required
Full name to extract initials from

Returns

Uppercase initials (first and last name first letters)

public TablerHeader Item(Action<HtmlTag> configure) #
Returns: TablerHeader

Add custom header item

Parameters

configure System.Action{HtmlForgeX.HtmlTag} requiredposition: 0
public TablerHeader Logo(String logoUrl, String brandUrl = null) #
Returns: TablerHeader

Set logo image URL

Parameters

logoUrl System.String requiredposition: 0
brandUrl System.String = null optionalposition: 1
Notification 2 overloads
public TablerHeader Notification(String title, String description = null, TablerNotificationType type = Default) #
Returns: TablerHeader

Add notification

Parameters

title System.String requiredposition: 0
description System.String = null optionalposition: 1
type HtmlForgeX.TablerNotificationType = Default optionalposition: 2
public TablerHeader Notification(Action<TablerNotification> configure) #
Returns: TablerHeader

Add notification with configuration

Parameters

configure System.Action{HtmlForgeX.TablerNotification} requiredposition: 0
public TablerHeader NotificationBell(Boolean enable = true) #
Returns: TablerHeader

Enable/disable notification bell

Parameters

enable System.Boolean = true optionalposition: 0
RegisterLibraries() #

Registers the required libraries for this component

RenderAppMenu() #

Renders the app menu dropdown

Returns

HTML string for the app menu

RenderBrand() #

Renders the brand/logo section

Returns

HTML string for the brand section

RenderDarkModeToggle() #

Renders the dark mode toggle buttons

Returns

HTML string for the dark mode toggle

RenderNotificationBell() #

Renders the notification bell dropdown

Returns

HTML string for the notification bell

RenderUserProfile() #

Renders the user profile dropdown

Returns

HTML string for the user profile dropdown

public TablerHeader Sticky(Boolean sticky = true) #
Returns: TablerHeader

Make header sticky

Parameters

sticky System.Boolean = true optionalposition: 0
public TablerHeader Style(TablerHeaderStyle style) #
Returns: TablerHeader

Set header style

Parameters

style HtmlForgeX.TablerHeaderStyle requiredposition: 0
public TablerHeader Surface(TablerSurfaceStyle style) #
Returns: TablerHeader

Applies a shared surface treatment to the header shell.

Parameters

style HtmlForgeX.TablerSurfaceStyle requiredposition: 0
public override String ToString() #
Returns: String

Renders the header to HTML string

Returns

HTML representation of the header

UserProfile 2 overloads
public TablerHeader UserProfile(String name, String title = null, String avatarUrl = null) #
Returns: TablerHeader

Set user profile

Parameters

name System.String requiredposition: 0
title System.String = null optionalposition: 1
avatarUrl System.String = null optionalposition: 2
public TablerHeader UserProfile(Action<TablerUserProfile> configure) #
Returns: TablerHeader

Configure user profile with fluent API

Parameters

configure System.Action{HtmlForgeX.TablerUserProfile} requiredposition: 0