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 (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 PatternsCardFilterFormLink 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 (primary)

OverviewStyleGuidelinesCodeAccessibilityDemos
ImportingUsagerh-navigation-primaryrh-navigation-primary-item-menurh-navigation-primary-itemrh-navigation-primary-overlayImportingUsagerh-navigation-primaryrh-navigation-primary-item-menurh-navigation-primary-itemrh-navigation-primary-overlay

Importing

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

<script type="module">
  import '@rhds/elements/rh-navigation-primary/rh-navigation-primary.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.

Lightdom CSS

This element requires you to load "Lightdom CSS" stylesheets for styling deeply slotted elements.

Note

Replace /path/to/ with path to the CSS file, whether local or CDN.

 
<link rel="stylesheet" href="/path/to/rh-navigation-primary/rh-navigation-primary-lightdom.css">

Usage

rh-navigation-primary

Primary navigation helps users orient themselves and move through websites and domains.

Slots 5
Slot Name Summary Description
logo

Use this slot to override the link and logo image for translations and sub sites.

Use this slot for <rh-primary-navigation-item> hamburger menu links and dropdowns
event
links
dropdowns
Attributes 3
Attribute DOM Property Description Type Default
mobile-toggle-label mobileToggleLabel

Sets the mobile toggle (hamburger) text, used for translations, defaults to 'Menu'

 
string
 
'Menu'
color-palette colorPalette

Sets color context for child components, overrides parent context

 
NavigationPrimaryPalette
 
unknown
accessible-label accessibleLabel

Customize the default aria-label on the <nav> container. Defaults to "main" if no attribute/property is set.

 
string
 
'main'
Methods 1
Method Name Description
close()

Close Menus
Events 0
None
CSS Shadow Parts 0
None
CSS Custom Properties 1
CSS Property Description Default
--rh-navigation-primary-z-index 102
Design Tokens 25
Token Copy
--rh-color-brand-red-light
--rh-color-purple-40
--rh-color-purple-60
--rh-font-family-body-text
--rh-color-surface-lightest
--rh-color-surface-darkest
--rh-color-text-primary
--rh-border-radius-default
--rh-border-radius-pill
--rh-color-surface-lighter
--rh-color-surface-darker
--rh-color-interactive-primary-default
--rh-color-gray-40
--rh-color-icon-subtle
--rh-color-icon-secondary
--rh-font-size-body-text-sm
--rh-border-width-md
--rh-space-xs
--rh-space-md
--rh-color-surface
--rh-space-lg
--rh-box-shadow-sm
--rh-space-2xl
--rh-border-width-sm
--rh-color-border-subtle

rh-navigation-primary-item-menu

Navigation Menu

Slots 1
Slot Name Summary Description

Place element content here
Attributes 0
None
Methods 0
None
Events 0
None
CSS Shadow Parts 0
None
CSS Custom Properties 0
None
Design Tokens 5
Token Copy
--rh-color-text-primary
--rh-color-surface
--rh-space-xl
--rh-space-3xl
--rh-space-2xl

rh-navigation-primary-item

Slots 3
Slot Name Summary Description
icon
summary
Attributes 6
Attribute DOM Property Description Type Default
open open 
boolean
 
false
summary summary 
string
 
unknown
variant variant 
'link' | 'dropdown'
 
'link'
hide-at hideAt

Hides the element at various container query based breakpoints. Breakpoints available 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl'

 
'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl'
 
undefined
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
Methods 2
Method Name Description
hide()
show()
Events 0
None
CSS Shadow Parts 0
None
CSS Custom Properties 0
None
Design Tokens 23
Token Copy
--rh-size-icon-02
--rh-space-sm
--rh-color-icon-subtle
--rh-border-width-lg
--rh-color-accent-brand
--rh-color-border-subtle
--rh-border-radius-pill
--rh-border-width-sm
--rh-color-surface
--rh-color-surface-lighter
--rh-color-surface-darker
--rh-color-text-primary
--rh-color-gray-50
--rh-color-gray-40
--rh-color-interactive-primary-hover
--rh-font-size-body-text-md
--rh-space-xl
--rh-space-lg
--rh-font-size-body-text-sm
--rh-space-md
--rh-border-width-md
--rh-color-interactive-primary-default
--rh-border-radius-default

rh-navigation-primary-overlay

Overlay

Slots 1
Slot Name Summary Description

Place element content here
Attributes 1
Attribute DOM Property Description Type Default
open open 
boolean
 
false
Methods 0
None
Events 0
None
CSS Shadow Parts 0
None
CSS Custom Properties 1
CSS Property Description Default
--rh-overlay-z-index 1
Design Tokens 2
Token Copy
--rh-color-gray-90
--rh-opacity-80
Edit this page on GitHub
© 2025 Red Hat Deploys by Netlify