SUI - HelpText
We are not using Dropbox anymore for UX definitions
please check SUI Studio instead: https://sui-components.now.sh/

Thanks

Help Text is a feedback that the system gives users to make them clearly understand which information is required or to notify them (after validation) of any errors in the entered data or of whether they were successful.
We will use the same type of feedback for the 2 types of system validations: “inline” or "after submission". 

Definition metadata

Status of definition 
Complete
Definition version number
1.0
Category
Atom
Last Changelog update
21/11/2017 (see details in the Changelog section)
Owners
UX @David G , UI @Daniel P , FE @Julian G 

Structure

This component is based on an informative text that is combined with other atoms such as Input, Text Area, Checkbox and Radio buttons.
It has different typologies according to whether it is Helptext (informative) or Validation. See the typologies below.

Types

Information HelpText
This is used for reporting general information, limits or causes.
It can be a fixed text just to remember some information to the user or it can be a “dynamic” text according to the data entered in the field. 
  • For example a dynamic characters counter
The color of the Information Feedback must be similar to the regular text on the page. Black or gray scale. It can’t be any other color to don’t be confused with the validation HelpText.

Validation HelpText
This is used for indicating whether the entered data is correct. It is provided by using the "Help Text" with a color depending on the validation:
  • Error = red color
  • Success = green color


Behavior

If the Informative and Validation feedback are combined, the informative one will be kept, and validation will be added as a new row next to the input field (between the input field and the informative help text).

When the Error or Succes feedback is used, the same color is given to the Label ant the  


Content

The Help Texts & Validation, especially Errors & Successes, must be completely clear to make the user understand what’s wrong or right.

The text must be clear, concise and short. 

Visual


Accessibility

This component should support all the recommendations that appear on the Accessibility & Inclusion Guidelines.