Developers

Overview Installation Usage Tokens Contributing

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

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 connect with us on Slack.

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.

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>.

Note that modules may be placed in the <head>. Since they are deferred by default, they will not block rendering.

NPM

Install RHDS using your team's preferred NPM package manager.

Once 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.

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>.

Note that Modules may be placed in the <head>. Since they are deferred by default, they will not block rendering.

Designers

To get started using our design system as a designer, go to the Designers page.