Installation
CDN Prerelease
We are currently working on our CDN, which will be soon moving into beta. This will be the preferred method of installation in the near future. If you are a Red Hat associate and have questions or comments about the CDN or installation process please join us in our Red Hat Design System Google chat.
In the meantime, install this component using npm
The recommended way to load RHDS is via the Red Hat Digital Experience CDN, and using an import map.
If you have full control over the page you are using, add an import map
to the <head>, pointing to the CDN, or update any existing import map.
If you are not responsible for the page's <head>, request that the
page owner makes the change on your behalf.
<script type="importmap">
{
"imports": {
"@rhds/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@rhds/elements@1.1.0/elements/",
"@patternfly/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@patternfly/elements@2.2.2/"
}
}
</script>Once the import map is established, you can load the element with the following module, containing a bare module specifier:
<script type="module">
import '@rhds/elements/rh-back-to-top/rh-back-to-top.js';
</script>Note that Modules may be placed in the <head>: since they are deferred by default,
they will not block rendering.
Install RHDS using your team's preferred NPM package manager, e.g.
npm install @rhds/elementsOnce that's been accomplished, you will need to use a bundler to resolve the bare module specifiers and optionally optimize the package for your site's particular use case and needs. Comprehensive guides to bundling are beyond the scope of this page; read more about bundlers on their websites:
Public CDNs
JSPM and other public CDNs should not be used on corporate domains. Use them for development purposes only!
Add an import map to the <head>, pointing to the CDN,
or update any existing import map.
<script type="importmap">
{
"imports": {
"@rhds/elements/": "https://jspm.dev/@rhds/elements/",
"@patternfly/elements/": "https://jspm.dev/@patternfly/elements/"
}
}
</script>Once the import map is established, you can load the element with the following module, containing a bare module specifier:
<script type="module">
import '@rhds/elements/rh-back-to-top/rh-back-to-top.js';
</script>Note that Modules may be placed in the <head>: since they are deferred by default,
they will not block rendering.
rh-back-to-top
Slots
- Default Slot
-
Text for the back to top link
Attributes
visible-
Flag to always show back to top button, defaults to false.
- DOM Property
visible- Type
-
'always' | undefined | undefined - Default
-
unknown
scrollable-selector-
Element selector to spy on for scrolling. Not passing a selector defaults to spying on window scroll events
- DOM Property
scrollableSelector- Type
-
string | undefined - Default
-
unknown
scroll-distance-
Distance from the top of the scrollable element to trigger the visibility of the back to top button
- DOM Property
scrollDistance- Type
-
number - Default
-
400
href-
Page fragment link to target element, must include hash ex: #top
- DOM Property
href- Type
-
string | undefined - Default
-
unknown
Methods
None
Events
None
CSS Shadow Parts
trigger-
back to top link anchor element
CSS Custom Properties
None
Design Tokens
Other libraries
To learn more about our other libraries, visit this page.
Feedback
To give feedback about anything on this page, contact us.
Red Hat legal and privacy links
- About Red Hat
- Jobs
- Events
- Locations
- Contact Red Hat
- Red Hat Blog
- Diversity, equity, and inclusion
- Cool Stuff Store
- Red Hat Summit
Red Hat legal and privacy links
