Skip to main content

Nav List Item

The Nav List component is a navigational element contained within a list.

Properties

NameTypeDefaultDescription
textstringSpecifies the text for the nav list item.
pathstringSpecifies the navigational path for the nav list item.
exactboolfalseIf true, the active style will be applied if the location is matched exactly.
disabledboolfalseIf true, the nav list item is disabled.
tooltipTitlestringDefines a tooltip for the nav list item.
tooltipPlacementbottom-end
bottom-start
bottom
left-end
left-start
left
right-end
right-start
right
top-end
top-start
top
string
bottomDefines the placement of the tooltip on the nav list item.
loopDataarrayDefines an array of options in the format id, label, value. The id must be is small letters.
itemNamestringDefines a unique identifier name for each menu item.

The Add Left Component allows the placement of an icon, badge, chip or container to the left-hand side of a nav list item.

Style Attributes

NameTypeDefaultDescription
alignItemscenter
flex-start
centerThe alignment applied to the nav list item.
denseboolfalseIf true, compact vertical padding is used for the nav list item.
disableGuttersboolfalseIf true, removes the gutter on the left-hand side of the nav list item.
dividerboolfalseIf true, adds a line beneath the nav list item.
backgroundColorhex#666666
rgb 5,5,5
Defines the background color.
textColorhex#666666
rgb 5,5,5
Defines the text color.
iconColorhex#666666
rgb 5,5,5
Defines the icon color if the nav list item has an attached icon.
selectedBackgroundColorhex#666666
rgb 5,5,5
Defines the background color if the nav list item is selected.
selectedTextColorhex#666666
rgb 5,5,5
Defines the text color if the nav list item is selected.
selectedIconColorhex#666666
rgb 5,5,5
Defines the icon color if the nav list item has an attached icon and is selected.
disableFocusRippleboolfalseIf true, the keyboard focus ripple is disabled.
disableRippleboolfalseIf true, the ripple effect is disabled.
on this page
Was this article useful?
89% of our users said this content was useful.