url |
string |
A location for the navigation item to navigate to when clicked |
matches |
boolean |
A boolean property indicating whether the navigation item should respond to a closely matching location property |
exactMatch |
boolean |
A boolean property indicating whether the navigation item should respond to an exactly matching location property |
matchPaths |
string[] |
A string property providing a collection of additional paths for the navigation item to respond to |
excludePaths |
string[] |
A string property providing an explicit collection of paths the navigation item should not respond to |
icon |
IconProps['source'] |
An icon to be displayed next to the navigation. Please prefer minor icons here. If a major icon has to be used, set the shouldResizeIcon prop to true |
badge |
string | null |
A string property allowing content to be displayed in a badge next to the navigation item |
label |
string |
A string property allowing content to be displayed as link text in the navigation item |
disabled |
boolean |
A boolean property indicating whether the navigation item is disabled |
new |
boolean |
Indicate whether the navigation item is new by adding an indicator dot to the parent and badge to the item (overwritten by the badge prop) |
accessibilityLabel |
string |
A visually hidden label for screen readers to understand the content of a navigation item |
selected |
boolean |
A boolean property indicating whether the navigation item is the currently-selected item |
shouldResizeIcon |
boolean |
Will allow for major icons to be displayed at the same size as minor icons |
subNavigationItems |
SubNavigationItem[] |
A collection of navigation items rendered as nested secondary navigation items |
secondaryAction |
SecondaryAction |
Renders an icon-only action as a supplementary action next to a navigation item |
onClick() |
function |
A callback function to handle clicking on a navigation item |