Package org.patternfly.component.icon


package org.patternfly.component.icon
Provides the icon component for rendering styled SVG icons with configurable size and status.

This package contains the Icon component for wrapping SVG icons from icon sets (such as FontAwesome or PatternFly icons) with consistent sizing and optional status coloring. Icons can be sized to match body text, heading text, or standalone sizes, and can display status colors for contextual meaning.

Components

  • Icon - Renders an icon with configurable size and status
  • IconSize - Defines available icon sizes (standalone, body, and heading sizes)

Usage

Creating icons with different sizes and status colors:

import static org.patternfly.component.icon.Icon.icon;
import static org.patternfly.component.icon.IconSize.lg;
import static org.patternfly.component.icon.IconSize.sm;
import static org.patternfly.component.icon.IconSize.xl;
import static org.patternfly.icon.IconSets.fas.checkCircle;
import static org.patternfly.icon.IconSets.fas.cog;
import static org.patternfly.icon.IconSets.fas.exclamationCircle;
import static org.patternfly.style.Status.danger;
import static org.patternfly.style.Status.success;

// Basic icons
Icon settingsIcon = icon(cog());

// Icons with sizes
Icon smallIcon = icon(checkCircle()).size(sm);
Icon largeIcon = icon(checkCircle()).size(lg);
Icon extraLargeIcon = icon(checkCircle()).size(xl);

// Icons with status colors
Icon successIcon = icon(checkCircle()).status(success);
Icon dangerIcon = icon(exclamationCircle()).status(danger);
See Also:
  • Class
    Description
    An icon component is a container that allows for icons of varying dimensions, as well as spinners, to seamlessly replace each other without shifting surrounding content.