Error message
<gcds-error-message>
Also called: error, inline error.
An error message is a description of a problem blocking a user goal.
-
GitHub -
Figma
Error message component preview
On this page
Coding and accessibility for error messages
Use error messages to support accessible task success
- Make sure a person can immediately access the form controls associated with the label the error message is attached to.
- Make your error message specific to avoid a user getting the same error message again after they thought they fixed the error.
- Avoid introducing additional steps. Let a person know exactly what to do to fix the error so they can take action and resubmit or revalidate without having to do extra work.
- Provide one or two solutions for fixing the error, not a multi-step process.
Note: All GC Design System components already come with default error handling for required form components.
Follow a predictable format for error messages
Provide simple, fast guidance that's in context and interrupts the flow of action as minimally as possible:
- Clearly identifies and points to the error.
- Defines the error without making the user's actions the source of the problem.
- Includes a call to action that's specific and actionable.
A person who receives an error message needs to:
- Find the error and be able to access it.
- Know what to do to fix it.
- Be able to make the changes.
- Resubmit or revalidate without having to fill out the whole form again.
In this section
message-id
The message-id attribute specifies the unique identifier for the error message.
<gcds-error-message message-id="message-default">
Error message.
</gcds-error-message>
default
The default slot is for adding the error message text.
<gcds-error-message message-id="message-default">
Error message.
</gcds-error-message>
Code builder
Generate an instance of the component you need by selecting its code properties.
-
Explore by choosing different code values to generate the instance you want.
-
Get the code and pull it into your environment.
-
Add any copy you need to the component (like text for a label).
Note: The code builder uses English for all code elements, which follows standard practice.
Help us improve
Have questions or a request? Give feedback on our contact form.
Something's wrong? Raise it through GitHub with an