Developers
Notice
Our new CDN server will be the preferred method of installation going forward. If you are a Red Hat associate and have questions or comments about the CDN or installation process please connect with us on Slack.
How to install
There are three ways you can install the Red Hat Design System's Web Components: CDN, NPM, or JSPM. Each element's "Code" page includes the same installation information with code snippets that are specific to that element.
Red Hat CDN
The recommended way to load the Red Hat Design System (RHDS) on Red Hat websites and applications is through the Red Hat Digital Experience CDN using an import map.
Note: Due to current information security standards regarding access to the CDN, the CDN only allows requests from *.redhat.com domains. This means for local development an /etc/hosts change to forward localhost to something like dev.foo.redhat.com and navigating to that instead of localhost is required. If you need help setting this up for your project please reach out on Slack.
Using import maps
- 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.
Base import map
Below is the base import map for using version 3.0.1 RHDS components.
<script type="importmap">
{
"imports": {
"@rhds/elements/": "https://www.redhatstatic.com/dssf-001/v2/@rhds/elements@3.0.1/elements/"
},
"scopes": {
"https://www.redhatstatic.com/dssf-001/v2/": {
"@floating-ui/core": "https://www.redhatstatic.com/dssf-001/v2/@floating-ui/core@1.6.9/dist/floating-ui.core.mjs",
"@floating-ui/dom": "https://www.redhatstatic.com/dssf-001/v2/@floating-ui/dom@1.6.13/dist/floating-ui.dom.mjs",
"@floating-ui/utils": "https://www.redhatstatic.com/dssf-001/v2/@floating-ui/utils@0.2.9/dist/floating-ui.utils.mjs",
"@floating-ui/utils/dom": "https://www.redhatstatic.com/dssf-001/v2/@floating-ui/utils@0.2.9/dist/floating-ui.utils.dom.mjs",
"@lit/context": "https://www.redhatstatic.com/dssf-001/v2/@lit/context@1.1.4/development/index.js",
"@lit/reactive-element": "https://www.redhatstatic.com/dssf-001/v2/@lit/reactive-element@2.0.4/reactive-element.js",
"@lit/reactive-element/decorators/": "https://www.redhatstatic.com/dssf-001/v2/@lit/reactive-element@2.0.4/decorators/",
"@patternfly/pfe-core": "https://www.redhatstatic.com/dssf-001/v2/@patternfly/pfe-core@5.0.1/core.js",
"@patternfly/pfe-core/": "https://www.redhatstatic.com/dssf-001/v2/@patternfly/pfe-core@5.0.1/",
"@rhds/elements/lib/": "https://www.redhatstatic.com/dssf-001/v2/@rhds/elements@3.0.1/lib/",
"@rhds/icons": "https://www.redhatstatic.com/dssf-001/v2/@rhds/icons@1.2.0/icons.js",
"@rhds/icons/": "https://www.redhatstatic.com/dssf-001/v2/@rhds/icons@1.2.0/",
"@rhds/tokens/media.js": "https://www.redhatstatic.com/dssf-001/v2/@rhds/tokens@3.0.0/js/media.js",
"@rhds/tokens/": "https://www.redhatstatic.com/dssf-001/v2/@rhds/tokens@3.0.0/",
"lit": "https://www.redhatstatic.com/dssf-001/v2/lit@3.2.1/index.js",
"lit/": "https://www.redhatstatic.com/dssf-001/v2/lit@3.2.1/",
"lit-element/lit-element.js": "https://www.redhatstatic.com/dssf-001/v2/lit-element@4.1.1/lit-element.js",
"lit-html": "https://www.redhatstatic.com/dssf-001/v2/lit-html@3.2.1/lit-html.js",
"lit-html/": "https://www.redhatstatic.com/dssf-001/v2/lit-html@3.2.1/",
"tslib": "https://www.redhatstatic.com/dssf-001/v2/tslib@2.8.1/tslib.es6.mjs"
}
}
}
</script>Loading individual elements
Once the import map is established, you can load individual elements using a bare module specifier.
For example, you can load <rh-button> using the following:
<rh-button>Primary</rh-button>
<script type="module">
import "@rhds/elements/rh-button/rh-button.js";
</script>Note that modules may be placed in the <head>. Since they are deferred by
default, they will not block rendering. Multiple import statements on the same page to the same
script in this manner are completely safe, and will be deduplicated, so the browser
won't make any additional calls as long as they use the same bare module specifier.
Still need CDN v1 bundles?
If you'd like to continue to use the bundles available in v1 of our CDN, they are still available on our new server at the following URL:
https://www.redhatstatic.com/dssf-001/v1/To migrate, change /dx/v1-alpha/ to /dssf-001/v1/ in your current URLs.
NPM
Install RHDS using your team's preferred NPM package manager.
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:
JSPM
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. The example below shows
how you'd load in <rh-button>.
<script type="module">
import "@rhds/elements/rh-button/rh-button.js";
</script>Note that Modules may be placed in the <head>. Since they are deferred by
default, they will not block rendering.
Lightdom CSS
Some elements require you to load "Lightdom CSS" stylesheets, which are necessary for styling deeply slotted child elements. In some cases, these may also help reduce some Cumulative Layout Shift (CLS) experience before the element has fully initialized, but are not intended to be used without initializing the element or by themselves to prevent CLS.
<link rel="stylesheet"
href="https://www.redhatstatic.com/dssf-001/v2/@rhds/elements@3.0.1/rh-footer/rh-footer-lightdom.css">Lightdom CSS shims
Some elements have provided an optional -lightdom-shim.css file to aid in limiting
CLS as much as possible, by styling some parts of the element before it has fully
initialized (i.e., :not(:defined)). These "shims" are inherently different than the
required "Lightdom CSS" mentioned above, and are only a temporary stop-gap until
Delcarative Shadow DOM is more widely available; at which point the shims will
no longer be needed and will become deprecated.
<link rel="stylesheet"
href="https://www.redhatstatic.com/dssf-001/v2/@rhds/elements@3.0.1/rh-cta/rh-cta-lightdom-shim.css">Designers
To get started using our design system as a designer, go to the Designers page.
