Skip link
Importing
Add rh-skip-link to your page with this import statement:
<script type="module">
import '@rhds/elements/rh-skip-link/rh-skip-link.js';
</script>
Copy to Clipboard
Copied!
Wrap lines
Overflow lines
To learn more about installing RHDS elements on your site using an import map read our getting started docs.
Lightdom CSS shim
Warning
Lightdom CSS shims are an optional, temporary solution for reducing CLS. Learn more about lightdom CSS shims .
<link rel="stylesheet" href="/path/to/rh-skip-link/rh-skip-link-lightdom-shim.css">
Note
Replace /path/to/ with path to the CSS file, whether local or CDN.
Usage
<rh-skip-link href="#main-content">Skip to main content</rh-skip-link>
<script type="module">
import '@rhds/elements/rh-skip-link/rh-skip-link.js';
</script>
Copy to Clipboard
Copied!
Wrap lines
Overflow lines
rh-skip-link
A skip link is used to skip repetitive content on a page. It is hidden by default and can be activated by hitting the "Tab" key after loading/refreshing a page.
Slots
1
| Slot Name | Summary | Description |
|---|---|---|
[default]
|
An anchor tag targeting the main page content by id hash.
Or, if the |
Attributes
1
| Attribute | DOM Property | Description | Type | Default |
|---|---|---|---|---|
href
|
href |
|
|
Methods
0
None
Events
0
None
CSS Shadow Parts
0
None
CSS Custom Properties
0
None
Design Tokens
13
| Token | Description | Copy |
|---|---|---|
--rh-color-surface-lightest
|
Primary surface (light theme) |
|
--rh-color-border-interactive-on-light
|
Interactive border color (light theme) |
|
--rh-border-radius-default
|
3px border radius; Example: Card |
|
--rh-color-interactive-primary-default-on-light
|
Primary interactive - default (Light theme) |
|
--rh-font-family-heading
|
Heading font family |
|
--rh-font-size-body-text-md
|
16px font size |
|
--rh-font-weight-heading-bold
|
Bold font weight for headings |
|
--rh-border-width-md
|
2px border width: Example: Alert |
|
--rh-space-lg
|
16px spacer |
|
--rh-space-2xl
|
32px spacer |
|
--rh-color-interactive-primary-hover
|
|
|
--rh-border-width-sm
|
1px border width; Example: Secondary CTA or Button |
|
--rh-color-interactive-primary-hover-on-light
|
Primary interactive - hover (Light theme) |
|
Other libraries
To learn more about our other libraries, visit this page.
Feedback
To give feedback about anything on this page, contact us.