Anatomy
- An error message displayed below the input
- An 18px "warning" icon
- Red error text
- A red border on the input
Helper text
Do
Place the error message above helper text.
Don't
Don't hide the helper text when an error occurs.
Input border
Do
Display the input border in red when there is an error.
Don't
Don't use any other border colour when the input is in an error state.
File uploader
Do
Display the error message below the file uploader.
Don't
Don't add a red border to the file uploader.
Language and tone
Be clear and concise
Be specific
Provide a solution
Be empathetic
Common error message patterns
Input is empty
[Action] + [Label] = Enter a first name
Do
Provide clear instructions.
Do
Provide clear instructions.
Don't
Don't use vague or non-actionable messages.
Incorrect information format
[Action] + a valid + [Label] + such as + [correct format] = Enter a valid postal code, such as T3R 8Y2
Do
Provide a clear positive solution with an example.
Don't
Don't use negative language without a solution.
Error with a date entry
[Topic] + must be + [duration] = Start date must be within study period.
Do
Give the user a clear idea of the acceptable date range.
Don't
Don't provide unclear explanations.
Error within a value range
[Label] + cost/amount/fee + must be + [qualifier] + [amount] = Tuition cost must be lower than $20,000
Do
Provide the correct value when known.
Don't
Don't show errors without explaining the acceptable value.
Input outside accepted values
[Label] + must be between + [# number] and [# number] + digits. = PID must be between 10 and 15 digits.
Do
Provide a clear acceptable range.
Don't
Don't provide an unclear solution.
Upload errors
- An unsupported file format is uploaded
- The file size exceeds the limit
- The upload fails
- A duplicate file is uploaded
- A required file is missing
Wrong file type
The selected file + must be + [List of accepted file formats] = The selected file must be PDF, JPEG, PNG, or TIFF
Do
Provide a list of accepted formats.
Don't
Don't use long or unclear wording.
File too large
The selected file + must be + [qualifier] + [size limit] = The selected file must be less than 5 MB
Do
Provide the exact file size limit.
Don't
Don't provide vague instructions.
File upload failed
[Problem statement] + [guided solution] = We experienced an error while uploading your file. Please try again
Do
Use empathetic language and take responsibility.
Don't
Don't use blunt or accusing language.
Duplicate file uploaded
[Problem statement] + [guided solution] = This file is already uploaded. Please upload a different one.
Do
Clearly explain the issue and next step.
Don't
Don't use negative phrasing without guidance.
No file selected
[Action] + [label] = Upload a work permit
Do
Provide clear instructions.
Don't
Don't use vague messages.
Format errors
Invalid characters used
You may only use + [valid characters] = You may only use Aa-Zz, 0-9, hyphen, and space.
Do
Provide the list of allowed characters.
Don't
Don't state the guided solution in two parts.
Accepted characters are known
[Label] + must include + [accepted characters] + (only)*, + such as + [example] = Alberta Bar ID must include numbers only, such as 123456
Do
Provide a clear guided solution.
Don't
Don't use unclear or wordy phrasing.
Incorrect number of characters
[Label] + must be + [# number] digits = Mobius reference number must be 10 digits
Do
Provide clear numeric requirements.
Don't
Don't display numbers in letters.
- Get feedback on your service
- Propose new components or patterns
- Suggest updates to existing resources
- Ask questions
- Share feedback