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 group 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 Readtime Scheme toggle Select Site status Skeleton Skip link Spinner Statistic Subnavigation Surface Switch Table Tabs Tag Tile Timestamp Tooltip Video embed OverviewColor PalettesCustomizingDevelopers All PatternsAccordionAlertCall 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
OverviewStatusWhen to useStatus checklistOverviewStatusWhen to useStatus checklist

Overview

Health index provides a visual grade (A through F) for communicating the health or security level of an item. Authors must set the grade attribute and should place it in context that makes its purpose clear. It uses ARIA meter role so screen reader users can read the grade. This element should not receive keyboard focus, as it is non-interactive.

import '@rhds/elements/rh-health-index/rh-health-index.js';
 
<rh-health-index grade="C" size="lg">C</rh-health-index>
 
import { HealthIndex } from "@rhds/elements/react/rh-health-index/rh-health-index.js";

// NOTE: React 19+ does not require these wrapper imports.
// You can use the custom elements directly as-is.

export const Demo = () => (
  <HealthIndex grade="C" size="lg">C</HealthIndex>
);

Sets the visual size of the health index. The sm size renders only the active grade letter. The default md size renders all grade boxes without labels. The lg and xl sizes render all grade letters with the active grade highlighted and bordered.

Sets the health grade from A (best) to F (worst). Grades A and B use success status colors, C uses warning, D uses caution, and E and F use danger. The value is case-insensitive; lowercase input is normalized to uppercase.

 View source on GitHub

Status

When to use

  • When you need to use severity to communicate the health of something
  • When you need to communicate how secure or vulnerable something is
  • When you need to measure how current or out of date something is

Status checklist

Edit this page on GitHub
© 2026 Red Hat Deploys by Netlify