eui documentation
  1. Components
  2. EuiHelperTextComponent

File

packages/components/eui-helper-text/eui-helper-text.component.ts

Description

A helper text component that provides supplementary information for form fields or UI elements. Displays descriptive text to guide users in completing forms or understanding interface elements.

Basic helper text

Example :
<eui-label>Password</eui-label>
<eui-input-text type="password"></eui-input-text>
<eui-helper-text>Must be at least 8 characters</eui-helper-text>

Accessibility

  • Should be associated with form controls using aria-describedby
  • Provides context without being intrusive
  • Text is readable by screen readers

Notes

  • Use for hints, format requirements, or additional context
  • Keep text concise and actionable
  • Combine with eui-feedback-message for validation errors

Metadata

selector eui-helper-text
template 
<ng-content/>
styleUrl ./eui-helper-text.scss

Index

HostBindings
Accessors

HostBindings

attr.type
Type : string
Default value : 'MessageFeedback'

Type attribute bound to the host element. Used to identify the component type in the DOM.
class
Type : string

Computes and returns the CSS classes for the feedback message component. Combines base state classes with muted state if applicable.

Accessors

cssClasses
getcssClasses()

Computes and returns the CSS classes for the feedback message component. Combines base state classes with muted state if applicable.

Returns : string

results matching ""

    No results matching ""