Error Suggestion
:
Understanding SC 3.3.3
3.3.3 Error Suggestion: If an input error is detected and suggestions for correction are known, then the suggestions are provided to the user, unless it would jeopardize the security or purpose of the content. (Level AA)
Intent of this Success Criterion
The intent of this Success Criterion is to ensure that users receive appropriate suggestions for correction of an input error if it is possible.
Success Criterion 3.3.1 provides for notification of errors. However, persons with cognitive limitations may find it difficult to understand how to correct the errors. People with visual disabilities may not be able to figure out exactly how to correct the error. In the case of an unsuccessful form submission, users may abandon the form because although they may be aware that an error has occurred, they may be unsure of how to correct the error even though they are aware that it has occurred.
The content author may provide the description of the error, or the user agent may provide the description of the error based on technology-specific, programmatically determined information.
Specific Benefits of Success Criterion 3.3.3:
-
Providing information about how to correct input errors allows users who have learning disabilities to fill in a form successfully. Users who are blind or have impaired vision understand more easily the nature of the input error and how to correct it. People with motion impairment can reduce the number of times they need to change an input value.
Examples of Success Criterion 3.3.3
-
Additional Help for Correcting An Input Error
The result of a form that was not successfully submitted describes an input error in place in the page along with the correct input and offers additional help for the form field that caused the input error.
-
Suggestions from a Limited Set of Values
An input field requires that a month name be entered. If the user enters "12," suggestions for correction may include
-
A list of the acceptable values, e.g., "Choose one of: January, February, March, April, May, June, July, August, September, October, November, December."
-
A description of the set of values, e.g., "Please provide the name of the month."
-
The conversion of the input data interpreted as a different month format, e.g., "Do you mean 'December'?"
-
Related Resources
Resources are for information purposes only, no endorsement implied.
(none currently documented)
Techniques and Failures for Success Criterion 3.3.3 - Error Suggestion
Each numbered item in this section represents a technique or combination of techniques that the WCAG Working Group deems sufficient for meeting this Success Criterion. The techniques listed only satisfy the Success Criterion if all of the WCAG 2.0 conformance requirements have been met.
Note: In some cases, more than one of these situations may apply. For example, when a mandatory field also requires the data to be in a specific format.
Sufficient Techniques
Instructions: Select the situation below that matches your content. Each situation includes techniques or combinations of techniques that are known and documented to be sufficient for that situation.
Situation B: If information for a field is required to be in a specific data format:
-
G85: Providing a text description when user input falls outside the required format or values
-
Providing links to suggested correction text "close to" form fields, or providing the suggested correction text itself directly on the Web page "next to" form fields (future link)
-
SCR18: Providing client-side validation and alert (Scripting)
-
Providing client-side validation and adding error text via the DOM (future link)
Situation C: Information provided by the user is required to be one of a limited set of values:
-
Providing links to suggested correction text "close to" form fields, or providing the suggested correction text itself directly on the Web page "next to" form fields (future link)
-
SCR18: Providing client-side validation and alert (Scripting)
-
Providing client-side validation and adding error text via the DOM (future link)
Additional Techniques (Advisory) for 3.3.3
Although not required for conformance, the following additional techniques should be considered in order to make content more accessible. Not all techniques can be used or would be effective in all situations.
-
G139: Creating a mechanism that allows users to jump to errors
-
Making error messages easy to understand and distinguishable from other text in the Web page (future link)
-
Validating form submissions on the server (future link)
-
When mandatory information has not been provided, including descriptions or examples of correct information in addition to identifying the field as mandatory (future link)
-
Repeating and emphasizing suggestions for correcting each input error in the context of its form field (future link)
-
Providing a way for the user to skip from each item in a list of suggestions to its corresponding form field (future link)
-
Providing additional contextual help for the form field requiring change (future link)
-
Accepting input data in a variety of formats (future link)
Techniques for providing suggestions to the user (Advisory)
-
Providing a text description that contains information about the number of input errors, suggestions for corrections to each item, and instructions on how to proceed (future link)
-
Providing a text description that contains suggestions for correction as the first item (or one of the first items) of content, or emphasizing this information in the content (future link)
-
Displaying errors and suggestions in the context of the original form (for example, re-displaying a form where input errors and suggestions for correction are highlighted and displayed in the context of the original form) (future link)
HTML Techniques (Advisory)
-
Providing "correct examples" for data and data formats as initial text in mandatory form fields (future link)
-
Providing links to suggested correction text "close to" form fields, or providing the suggested correction text itself directly on the Web page "next to" form fields (future link)
Client-Side Scripting Techniques (Advisory)
-
SCR18: Providing client-side validation and alert (Scripting)
-
Providing client-side validation and adding error text via the DOM (future link)
-
Calling a function from the submit action of a form to perform client side validation (future link)
Common Failures for SC 3.3.3
The following are common mistakes that are considered failures of Success Criterion 3.3.3 by the WCAG Working Group.
(No failures currently documented)
Key Terms
- input error
-
information provided by the user that is not accepted
Note: This includes:
-
Information that is required by the Web page but omitted by the user
-
Information that is provided by the user but that falls outside the required data format or values
-