Skip to main content Home About the Design SystemRoadmap OverviewDesignersDevelopers OverviewColorGridIconographyInteractionsSpacingTypography Overview Global colorBox shadowTypographyBorderOpacitySpaceLengthIconBreakpointsMedia queries 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 Menu dropdown Navigation link Navigation (primary) Navigation (secondary) Navigation (vertical) Pagination PopoverPlanned Progress stepper Scheme toggle Site status Skeleton Skip link Spinner Statistic Subnavigation Surface Switch Table Tabs Tag Tile Timestamp Tooltip Video embed OverviewColor PalettesCustomizingDevelopers All PatternsAccordionCall to ActionCardFilterFormLink with iconLogo wallSearch barSticky bannerSticky cardTabsTagTile All Personalization PatternsAnnouncement FundamentalsAccessibility toolsAssistive technologiesCI/CDContentContributorsDesignDevelopmentManual testingResourcesScreen readers Design/code status Release notes Get support

Health index

OverviewStyleGuidelinesCodeAccessibilityDemos
ImportingUsagerh-health-indexImportingUsagerh-health-index

Importing

Add rh-health-index to your page with this import statement:

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

<rh-health-index grade="C"
                 size="lg">C</rh-health-index>

<script type="module">
  import '@rhds/elements/rh-health-index/rh-health-index.js';
</script>
Copy to Clipboard Wrap lines

rh-health-index

Health index displays a health grade (A–F) for a particular item or package.

Slots 0
None
Attributes 2
Attribute DOM Property Description Type Default
size size

Sets the size of the health index Defaults to md

 
'sm' | 'md' | 'lg' | 'xl'
 
'md'
grade grade

Sets the health grade Defaults to A

 
'A' | 'B' | 'C' | 'D' | 'E' | 'F'
 
'A'
Methods 0
None
Events 0
None
CSS Shadow Parts 0
None
CSS Custom Properties 0
None
Design Tokens 24
Token Summary Copy
--rh-space-lg
--rh-color-surface-status-success
--rh-color-status-success
--rh-color-surface-status-warning
--rh-color-status-warning
--rh-color-surface-status-caution
--rh-color-status-caution
--rh-color-surface-status-danger
--rh-color-status-danger
--rh-space-xl
--rh-space-2xl
--rh-font-size-body-text-xl
--rh-font-size-body-text-md
--rh-font-family-code
--rh-color-border-subtle
--rh-color-surface-dark
--rh-color-border-subtle-on-light
--rh-color-icon-subtle
--rh-color-surface-lightest
--rh-length-xs
--rh-font-weight-code-medium
--rh-color-text-primary
--rh-color-surface-darkest
--rh-border-width-sm
Edit this page on GitHub
© 2025 Red Hat Deploys by Netlify