(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)

Icon

Overview

• The Icon component is a versatile UI element that displays an interactive icon.
• It supports customizable appearance, behavior, and conditional display options.
• The component includes styling options, tooltips, and hover states.
• Icons can change appearance dynamically based on data context.
• It is useful for interactive indicators, status displays, or clickable action buttons.

Specs

Tokens

Structure

(Configured in General Properties)

• displayName – Sets the display name of the component shown in the structure panel. For example, "Status Indicator Icon" allows for easy identification of the icon's purpose in the component structure, making it easier for developers to locate and work with this specific icon.

(Configured in Visual Properties)

• name – Specifies the icon to display from the available icon library. For example, setting to "check-circle" displays a checkmark icon that can represent completion or success. This is the primary visual element of the component.
• thresholdConfig – Configures conditional display rules that change the icon's appearance based on context data. For example, you can set rules to display a green check icon when a status is "complete" and a red warning icon when status is "overdue". This enables dynamic visual feedback based on data values.

(Configured in Visibility)

• displayConditions – Defines conditions for displaying the component. This allows showing or hiding the icon based on complex rules involving form values, user roles, or application state. For example, the icon might only be shown when certain data conditions are met or when the user has specific permissions.

Tooltip

(Configured in Visual Properties)

• showTooltip – Determines whether a tooltip appears when hovering over the icon. When enabled, provides additional context or instructions about the icon's purpose to users who may not immediately recognize its meaning.
• tooltipTextTranslations – Sets the text displayed in the tooltip with support for multiple languages. For example, {"en-US": "Complete Task", "de-DE": "Aufgabe abschließen"} ensures proper localization of tooltip messages. This property can use template expressions to show dynamic content from context data.
• tooltipPlacement – Determines the position of the tooltip relative to the icon. Options include "top", "bottom", "left", and "right". For example, "top" places the tooltip above the icon, which is useful in most standard layouts.
• tooltipDelay – Sets the delay in milliseconds before the tooltip appears when hovering over the icon. For example, setting to "500" will delay the tooltip appearance by half a second, preventing tooltips from appearing too quickly during casual mouse movements.

Styling

(Configured in Visual Properties)

• size – Sets the size of the icon. Options include "sm" (small) or "lg" (large). For example, choosing "lg" creates a more prominent icon that can serve as a focal point, while "sm" works well for inline indicators or dense layouts.
• widthAuto – Controls whether the icon component automatically sizes to fit its content. When set to true, the icon will take only as much width as needed; when false, it will fill available space in its container according to specified dimensions.
• iconOnHover – Specifies an alternate icon to display when the user hovers over the component. For example, setting "edit" as the hover icon on a "view" primary icon indicates that clicking will allow editing the item. This provides interactive feedback to users.
• paddingClass – Configures spacing around the icon using CSS classes. For example, "p-2" adds light padding on all sides of the icon, improving its visual spacing within its container.

Actions & Variants

(Configured in Events)

• events – Configures the events that the component can trigger and respond to.
• ON_ICON_CLICK – Triggered when the icon is clicked. Can be used to execute workflows, navigate to other screens, or perform data operations based on user interaction.
• ON_INIT – Triggered when the icon component is initialized. Can be used to perform setup operations when the icon first appears.
• ON_DESTROY – Triggered when the icon component is removed from the DOM. Useful for cleanup operations and releasing resources.

Authorization

(Configured in Authorization)

• visibilityPolicySetId – Determines the visibility of the component based on specified policy sets. For example, setting to "adminAct

Links:

• Figma: https://www.figma.com/design/yck1tcUXgdQ5aYX6iUAwrO/GE---Astronaut-Design-System?node-id=4473-363995&t=ftfrOGkPzlG2GaTo-1
• Live style guide: https://e1-dev.k8s.myapp.de/live-style-guide/id1/1-icons-24

Guidelines

Usage

• Use the Icon to present a recognizable symbol via name when a compact, tappable affordance or status indicator is needed.
• Use an Icon as an actionable control when you can wire outcomes to ON_ICON_CLICK.
• Use an Icon for data or status feedback when the graphic should react to context using thresholdConfig.
• Provide contextual hints with tooltips only as supplemental help by enabling showTooltip and supplying tooltipTextTranslations. Do not put critical information exclusively in the tooltip.

Sizing & Layout

• Select an appropriate icon scale using size (e.g., "sm", "lg") to match density and emphasis.
• Control horizontal growth with widthAuto; set it to true for intrinsic sizing, or false when the icon should fill its available width.
• Adjust local spacing around the icon using paddingClass to achieve comfortable touch or click targets and visual balance.

States & Feedback

• Provide hover affordance by specifying iconOnHover so the icon swaps on pointer hover.
• Convey dynamic status by mapping data-driven rules to thresholdConfig that switch name to appropriate status glyphs.
• Surface explanatory help on hover via showTooltip with a considerate tooltipDelay to avoid accidental popups.

Tooltips

• Turn on tooltips with showTooltip and provide localized copy with tooltipTextTranslations.
• Position the tooltip so it does not occlude nearby content by choosing tooltipPlacement that best fits the context.
• Use tooltipDelay to reduce flicker during transient hovers; 300–500 ms is a common range.
• Treat tooltips as supplemental only; never put essential instructions exclusively in the tooltip.

Data-Driven / Conditional Behavior

• Define robust rule sets in thresholdConfig that map clear conditions to specific name values, and include a default rule to prevent unmapped states.
• To minimize jarring oscillation when incoming data flutters near a boundary, prefer non-overlapping, explicit conditions in thresholdConfig.

Visibility & Authorization

• Gate visibility based on policies using visibilityPolicySetId when the icon should appear only for allowed audiences.
• Show or hide the icon contextually by configuring displayConditions tied to relevant data or state.

Content & Localization

• Localize all user-facing strings by supplying tooltipTextTranslations for tooltips and localized guidedTourHotSpotTitle / guidedTourHotSpotDescription when using hotspots.

Dos & Don’ts

Accessibility

• Provide localized, concise tooltip content using tooltipTextTranslations when showTooltip is enabled to assist recognition without depending on language-specific icons.
• Avoid color-only meaning by swapping to distinct glyphs or filled or outlined variants via thresholdConfig.
• Ensure icons intended as actions clearly indicate interactivity by defining iconOnHover so hover state is perceivable.
• Expose stable hooks for automated accessibility tests and focus workflows with dataTestId and id.
• For guided help, provide descriptive, localized copy through guidedTourHotSpotTitle and guidedTourHotSpotDescription when enableAsHotspot is set.
• Pair data-driven icon changes from thresholdConfig with tooltipTextTranslations so meaning is not conveyed by color or shape alone.
• Use paddingClass to create comfortable hit areas and reduce accidental clicks, supporting motor accessibility.
• Prevent surprise tooltips by setting a considerate tooltipDelay and choosing non-obscuring tooltipPlacement.