Inline error
Inline errors are brief, in-context messages that tell merchants something went wrong with a single or group of inputs in a form. Use inline errors to help merchants understand why a form input may not be valid and how to fix it.
Props
No props found for this component, run `yarn gen:docs` to generate component meta first.
Best practices
Inline errors should:
- Be brief
- Be written in sentence case
- Be visible immediately upon a form input that is not valid
- Be removed as soon as the input is valid so merchants can immediately tell they fixed the issue
- Describe specific solutions so merchants can successfully complete their task in the form
- Not be placed out of context of the input or group of inputs they describe
Learn more about error message patterns
Content guidelines
Inline error messages
Since the error message is directly below the source of the problem, the copy only needs to explain why the error happened. Optionally, the message can clarify what to do next or offer a one-click fix.
Inline error messages should:
- Clearly explain what went wrong, give a next step, or offer a one-click fix
- Be short and concise, no more than a single sentence
- Use passive voice so merchants don’t feel like they’re being blamed for the error
Related components
- To create a list of exceptions that describe a resource, use the exception list component
Accessibility
- Use the required
fieldIdprop to give the inline error a uniqueid. This ties the error to a form field usingaria-describedbyso that it's conveyed to screen reader users. - Use the required
messageprop to provide the text that describes the error. - The inline error icon helps visually identify the error message for merchants who have difficulty seeing colors or who use settings that remove color from the page.