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 stepsPlanned Site status Skip link Spinner Statistic Subnavigation Surface Switch Table Tabs Tag Tile Timestamp Tooltip Video embed
Theming OverviewColor PalettesCustomizingDevelopers
Patterns All PatternsCardTabsFilterFormLink with iconLogo wallSearch barSticky bannerSticky cardTile
Personalization All Personalization PatternsAnnouncement
Accessibility FundamentalsAccessibility toolsAssistive technologiesCI/CDContentContributorsDesignDevelopmentManual testingResourcesScreen readers
Design/code status Release notes Get support

Jump links

OverviewStyleGuidelinesCodeAccessibilityDemos
ImportingUsagerh-jump-linksrh-jump-linkrh-jump-links-listImportingUsagerh-jump-linksrh-jump-linkrh-jump-links-list

Importing

Add rh-jump-links to your page with this import statement:

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

<div id="jump-links-demo-container">
  <aside>
    <h2 id="sections">Sections</h2>
    <rh-jump-links aria-labelledby="sections">
      <rh-jump-link href="#section-1">Section 1</rh-jump-link>
      <rh-jump-link href="#section-2">Section 2</rh-jump-link>
      <rh-jump-link href="#section-3">Section 3</rh-jump-link>
      <rh-jump-link href="#section-4">Section 4</rh-jump-link>
      <rh-jump-link href="#section-5">Section 5</rh-jump-link>
    </rh-jump-links>
  </aside>
  <p>Lorem ipsum dolor sit amet consectetur, adipisicing elit. Impedit itaque veniam animi iure corporis quibusdam error, necessitatibus inventore fugiat, minus natus eaque provident eius facilis.
    Dolorem qui tenetur quaerat facere!</p>
</div>

<script type="module">
  import '@rhds/elements/rh-jump-links/rh-jump-links.js';
</script>

<style>
  #jump-links-demo-container {
    display: grid;
    grid-template-columns: max-content auto;
    gap: var(--rh-space-lg);

    aside {
      h2 {
        font-weight: var(--rh-font-weight-heading-medium);
        font-family: var(--rh-font-family-body-text);
        font-size: var(--rh-font-size-body-text-md);
        line-height: var(--rh-line-height-body-text, 1.5);
        margin-block-end: var(--rh-space-lg);
      }
    }
  }
</style>
Copy to Clipboard Wrap lines

Jump links allow users to navigate sections of content on a page.

Slots 1
Slot Name Description

Place <rh-jump-link> or <rh-jump-links-list> elements here

Attributes 2
Attribute DOM Property Description Type Default
orientation orientation

Whether the layout of children is vertical or horizontal.

'horizontal' | 'vertical'
'vertical'
accessible-label accessibleLabel

Accessible label for nav

string | undefined
unknown
Methods 1
Method Name Description
orientationChanged()
Events 1
Event Name Description
toggle

when the expanded disclosure widget is toggled

CSS Shadow Parts 0
None
CSS Custom Properties 0
None
Design Tokens 8
Token Copy
--rh-border-width-sm
Full CSS Variable Permalink to this token
--rh-color-border-subtle
Full CSS Variable Permalink to this token
--rh-color-gray-40
Full CSS Variable Permalink to this token
--rh-color-gray-50
Full CSS Variable Permalink to this token
--rh-color-text-primary
Full CSS Variable Permalink to this token
--rh-length-4xs
Full CSS Variable Permalink to this token
--rh-space-3xl
Full CSS Variable Permalink to this token
--rh-space-lg
Full CSS Variable Permalink to this token
Slots 0
None
Attributes 2
Attribute DOM Property Description Type Default
active active

Whether this item is active.

boolean
false
href href

hypertext reference for this link

string | undefined
unknown
Methods 0
None
Events 1
Event Name Description
select
CSS Shadow Parts 0
None
CSS Custom Properties 0
None
Design Tokens 11
Token Copy
--rh-border-radius-default
Full CSS Variable Permalink to this token
--rh-color-border-status-neutral
Full CSS Variable Permalink to this token
--rh-color-brand-red
Full CSS Variable Permalink to this token
--rh-color-interactive-primary-default
Full CSS Variable Permalink to this token
--rh-color-interactive-secondary-default
Full CSS Variable Permalink to this token
--rh-color-interactive-secondary-focus
Full CSS Variable Permalink to this token
--rh-color-interactive-secondary-hover
Full CSS Variable Permalink to this token
--rh-color-text-primary
Full CSS Variable Permalink to this token
--rh-length-xs
Full CSS Variable Permalink to this token
--rh-space-lg
Full CSS Variable Permalink to this token
--rh-space-md
Full CSS Variable Permalink to this token
Slots 0
None
Attributes 1
Attribute DOM Property Description Type Default
active active

Whether this item is active.

boolean
false
Methods 0
None
Events 0
None
CSS Shadow Parts 0
None
CSS Custom Properties 0
None
Design Tokens 5
Token Copy
--rh-color-border-subtle
Full CSS Variable Permalink to this token
--rh-color-brand-red
Full CSS Variable Permalink to this token
--rh-length-4xs
Full CSS Variable Permalink to this token
--rh-length-xs
Full CSS Variable Permalink to this token
--rh-space-lg
Full CSS Variable Permalink to this token
© 2021-2025 Red Hat, Inc. Deploys by Netlify