InterfaceUserPortalNavbarProps

Admin Docs

---

Interface: InterfaceUserPortalNavbarProps

Defined in: src/types/UserPortalNavigationBar/interface.ts:56

Main component props interface

Properties

branding?

optional branding: BrandingConfig

Defined in: src/types/UserPortalNavigationBar/interface.ts:66

Branding configuration for logo and brand name

---

className?

optional className: string

Defined in: src/types/UserPortalNavigationBar/interface.ts:155

Additional CSS class names

---

currentPage?

optional currentPage: string

Defined in: src/types/UserPortalNavigationBar/interface.ts:78

Current active page identifier (matches NavigationLink.id) Used to highlight the active navigation link

---

customStyles?

optional customStyles: CSSProperties

Defined in: src/types/UserPortalNavigationBar/interface.ts:160

Inline styles

---

expandBreakpoint?

optional expandBreakpoint: "sm" | "md" | "lg" | "xl"

Defined in: src/types/UserPortalNavigationBar/interface.ts:126

Breakpoint at which navbar expands

Default

'md'

---

fetchOrganizationData?

optional fetchOrganizationData: boolean

Defined in: src/types/UserPortalNavigationBar/interface.ts:96

Whether to fetch organization data via GraphQL

Default

true when mode === 'organization'

---

mobileLayout?

optional mobileLayout: "collapse" | "offcanvas"

Defined in: src/types/UserPortalNavigationBar/interface.ts:132

Mobile layout style

Default

'collapse' for user mode, 'offcanvas' for organization mode

---

mode?

optional mode: "organization" | "user"

Defined in: src/types/UserPortalNavigationBar/interface.ts:61

Navigation mode - determines default behavior and styling

Default

'user'

---

navigationLinks?

optional navigationLinks: NavigationLink[]

Defined in: src/types/UserPortalNavigationBar/interface.ts:72

Array of navigation links to display in the navbar Only shown in organization mode or when explicitly provided

---

onLanguageChange()?

optional onLanguageChange: (languageCode) => void | Promise<void>

Defined in: src/types/UserPortalNavigationBar/interface.ts:144

Custom language change handler If not provided, uses default i18next language change

Parameters

languageCode

string

Returns

void | Promise<void>

---

onLogout()?

optional onLogout: () => void | Promise<void>

Defined in: src/types/UserPortalNavigationBar/interface.ts:138

Custom logout handler If not provided, uses default logout behavior based on mode

Returns

void | Promise<void>

---

onNavigation()?

optional onNavigation: (link) => void | Promise<void>

Defined in: src/types/UserPortalNavigationBar/interface.ts:150

Custom navigation handler If not provided, uses react-router navigation

Parameters

link

NavigationLink

Returns

void | Promise<void>

---

organizationId?

optional organizationId: string

Defined in: src/types/UserPortalNavigationBar/interface.ts:84

Organization ID - required for organization mode Used for GraphQL queries and navigation

---

organizationName?

optional organizationName: string

Defined in: src/types/UserPortalNavigationBar/interface.ts:90

Organization name - can be provided directly or fetched via GraphQL If not provided and fetchOrganizationData is true, will be fetched

---

showLanguageSelector?

optional showLanguageSelector: boolean

Defined in: src/types/UserPortalNavigationBar/interface.ts:108

Show language selector dropdown

Default

true

---

showNotifications?

optional showNotifications: boolean

Defined in: src/types/UserPortalNavigationBar/interface.ts:102

Show notification icon component

Default

true when mode === 'user', false when mode === 'organization'

---

showUserProfile?

optional showUserProfile: boolean

Defined in: src/types/UserPortalNavigationBar/interface.ts:114

Show user profile dropdown

Default

true

---

userName?

optional userName: string

Defined in: src/types/UserPortalNavigationBar/interface.ts:166

Override user name (for testing or external state management) If not provided, reads from localStorage

---

variant?

optional variant: "dark" | "light"

Defined in: src/types/UserPortalNavigationBar/interface.ts:120

Navbar color variant

Default

'dark'