Optional
canonicalHref?: stringOptional
href?: stringThe URL that the navigation item links to when clicked. Must be defined if id
is undefined
.
Optional
id?: stringAn optional unique identifier (useful for applying custom behavior onClick).
Optional
isActiveUrlPattern?: stringAn optional regex pattern (as a string accepted by
new RegExp()
)
used to check if this item is active, tested against the pathname of currentLocation
.
For example, /communication/(inbox|archive)
marks the item active for
/communication/inbox
or /communication/archive
, but not /communication/contact
.
If not provided, the item is active whenever currentLocation
starts with (or is equal to) href
.
For instance, if href
is /payroll/month
, it would be active if currentLocation
is /payroll/month/warningList/2024-01-25
.
Optional
notifications?: numberThe number of notifications associated with this item.
Optional
open?: undefinedNot allowed on single items.
Optional
subItems?: undefinedNot allowed on single items.
A stable, canonical URL used for the "last visited" section on the overview page.
It should not include volatile segments such as user IDs, order numbers, etc., so that different concrete URLs map back to the same logical destination.