Help Text

The Avonni Help Text displays a small icon that reveals contextual information in a tooltip when users hover over or focus on it. Use it to add brief guidance next to a field, label, or section without cluttering the page.

Overview

The Help Text is intentionally simple: it shows an icon, and when a user points at or tabs to that icon, the tooltip content you define appears. Because it has no data source of its own, configuration is quick — you choose the tooltip content, which icon to display, the icon's color treatment, and what screen readers should announce. The sections below follow the configuration panel from top to bottom, so you can read along as you build.

Configuration

To configure the Help Text, select it on the canvas. The Edit Help Text panel opens on the right with three tabs: Properties, Interactions, and Style. The sections below mirror the Properties tab.

Properties

The Properties tab contains all of the Help Text's settings in a single group.

Content

The Content setting holds the text shown inside the tooltip. It is displayed when users hover over or focus on the icon, so use it to provide the guidance or explanation you want them to read.

Icon Name

The Icon Name setting chooses which icon represents the help text. Pick any Lightning Design System icon so the visual cue matches the context — for example, an information or question icon.

Variant

The Variant setting changes the appearance of the icon so it stays visible against its background. Pick the option that fits the area around it:

• Bare (default) — the standard icon appearance.
• Inverse — a light icon designed to stand out against dark backgrounds.
• Warning — styles the icon to signal a warning.
• Error — styles the icon to signal an error.

Alternative Text

The Alternative Text setting lets you provide assistive text for the icon button. Assistive technologies, such as screen readers, announce this text so that users who can't see the icon still understand its purpose.

Set Component Visibility

All components support conditional visibility — see Component Visibility.