Skip to main content Home
About About the Design SystemRoadmap
Get started OverviewDesignersDevelopers
Foundations OverviewColorGridIconographyInteractionsSpacingTypography
Tokens Overview Global colorBox shadowTypographyBorderOpacitySpaceLengthIconBreakpointsMedia queries
Elements All elements Accordion Alert Announcement Audio player Avatar Back to top Badge Blockquote Breadcrumb Button Card Chip Code block Call to action Dialog Disclosure Footer Health index Icon Jump links Navigation link Navigation (primary) Navigation (secondary) Pagination PopoverPlanned Progress stepper Scheme toggle Site status Skeleton Skip link Spinner Statistic Subnavigation Surface Switch Table Tabs Tag Tile Timestamp Tooltip Video embed
Theming OverviewColor PalettesCustomizingDevelopers
Patterns All PatternsCall to ActionCardFilterFormLink with iconLogo wallSearch barSticky bannerSticky cardTabsTagTile
Personalization All Personalization PatternsAnnouncement
Accessibility FundamentalsAccessibility toolsAssistive technologiesCI/CDContentContributorsDesignDevelopmentManual testingResourcesScreen readers
Design/code status Release notes Get support

Navigation link

OverviewCodeDemos
ImportingUsagerh-navigation-linkImportingUsagerh-navigation-link

Importing

Add rh-navigation-link to your page with this import statement:

<script type="module">
  import '@rhds/elements/rh-navigation-link/rh-navigation-link.js';
</script>
Copy to Clipboard Wrap lines

To learn more about installing RHDS elements on your site using an import map read our getting started docs.

Usage 

<rh-navigation-link href="#link">Link</rh-navigation-link>
<rh-navigation-link><a href="#link">Slotted a href Link</a></rh-navigation-link>
<rh-navigation-link icon="auto-light-dark-mode" icon-set="ui" href="#ai">Containers</rh-navigation-link>
<script type="module">
  import '@rhds/elements/rh-navigation-link/rh-navigation-link.js';
</script>
Copy to Clipboard Wrap lines

Navigation Link is a link that is used as a child of the primary, secondary, subnav, and vertical navigation elements. The link is intrinsically an list item and should not be used outside of navigation elements that define the parent list element.

Slots 2
Slot Name Summary Description
icon

Use this slot when the icon and icon-set attributes are not set. Must be used in conjunction with the href attribute.
Can contain a rh-icon, svg, or img tag.

The default slot should contain the link text when the href attribute is set. Alternatively, an anchor tag (<a href="...">) should be the first child inside the slot. Slot should never contain a button tag.
Attributes 4
Attribute DOM Property Description Type Default
icon icon

Shorthand for the icon slot, the value is icon name

 
IconNameFor<IconSetName>
 
unknown
icon-set iconSet

Icon set for the icon property - 'ui' by default

 
IconSetName
 
unknown
href href

The URL to navigate to when the link is clicked

 
string
 
unknown
current-page currentPage

Indicates that this link refers to the current page for accessibility; used with the href attribute. Sets the aria-current attribute to 'page' on the anchor element internally in the shadow DOM.

 
boolean
 
false
Methods 1
Method Name Description
scheduleUpdate()
Events 0
None
CSS Shadow Parts 0
None
CSS Custom Properties 0
None
Design Tokens 7
Token Summary Copy
--rh-color-text-primary
--rh-color-interactive-primary-hover
--rh-color-gray-50
--rh-color-gray-40
--rh-border-width-md
--rh-color-interactive-primary-default
--rh-border-radius-default
Edit this page on GitHub
© 2025 Red Hat Deploys by Netlify