mozilla
Your Search Results

    alerts

    The problem

    You have a form — a contact form, for example — that you want to put some accessible error checking into. Common problems are e-mail addresses that are not valid, or a name that does not contain at least a first and a surname.

    The form

    First, please read about the aria-required technique first if you have not done so, as this technique expands upon that.

    Here is a simple form:

     <form method="post" action="post.php">
       <fieldset>
         <legend>Please enter your contact details</legend>
         <label for="name">Your name (required):</label>
         <input name="name" id="name" aria-required="true"/>
         <br />
         <label for="email">E-Mail address (required):</label>
         <input name="email" id="email" aria-required="true"/>
         <br />
         <label for="website">Website (optional):</label>
         <input name="website" id="website"/>
       </fieldset>
       <label for="message">Please enter your message (required):</label>
       <br />
       <textarea name="message" id="message" rows="5" cols="80"  
                 aria-required="true"></textarea>
       <br />
       <input type="submit" name="submit" value="Send message"/>
       <input type="reset" name="reset" value="Reset form"/>
     </form>
    

    Straight and simple, but we’re not here to win beauty prizes anyway. :-)

    Checking for validity and notifying the user

    Checking the validity and notifying the user consists of several steps:

    1. Checking if the e-mail address or entered name are valid. To keep it simple, we’ll check whether the e-mail address contains the “@” symbol, and if the name entry contains at least 1 space characters ” “.
    2. Setting the field’s aria-invalid attribute and giving it a value of “true”.
    3. Notifying the user via an alert that the value entered was incorrect. Instead of using an intrusive dialog box created by the JavaScript ‘alert’ function, we’ll use a simple WAI-ARIA widget to do it. This notifies the user, but lets them continue interacting with the form without any interruptions.

    All of this happens when the input loses focus, meaning in the “onblur” handler.

    The JavaScript code I wrote looks like this, inserted above the closing “head” tag:

     <script type="application/javascript">
     function removeOldAlert()
     {
       var oldAlert = document.getElementById("alert");
       if (oldAlert)
         document.body.removeChild(oldAlert);
     }
     <br/>
     function addAlert(aMsg)
     {
       removeOldAlert();
       var newAlert = document.createElement("div");
       newAlert.setAttribute("role", "alert");
       newAlert.setAttribute("id", "alert");
       var msg = document.createTextNode(aMsg);
       newAlert.appendChild(msg);
       document.body.appendChild(newAlert);
     }
     <br/>
     function checkValidity(aID, aSearchTerm, aMsg)
     {
       var elem = document.getElementById(aID);
       var invalid = (elem.value.indexOf(aSearchTerm) < 0);
       if (invalid) {
         elem.setAttribute("aria-invalid", "true");
         addAlert(aMsg);
       } else {
         elem.setAttribute("aria-invalid", "false");
         removeOldAlert();
       }
     }
     </script>
    

    The checkValidity function

    The core is the checkValidity function. It takes three parameters: The ID of the input that is to be validated, the term to search for to ensure validity, and the error message to be inserted into the alert.

    To see if it is valid, the function checks whether the indexOf the input’s value is anything greater than -1. A value of -1 or less is returned if the index of the search term could not be found within the value.

    If invalid, the function does two things:

    1. It sets the element’s aria-invalid attribute to “true”, which will indicate to screen readers that there is invalid content in here.
    2. It will call the addAlert function to add the alert with the provided error message.

    If the search term is found, the aria-invalid attribute is reset to “true”. In addition, any alert that still might be around is removed.

    The addAlert function

    This function first removes any old alerts. The function is simple: It looks for an element with id “alert”, and if found, removes that from the document object model.

    Next, the function creates a div element to hold the alert text. It gets an ID of “alert”. And it gets a role set of “alert”. This is actually ARIA-inspired, even though it doesn’t say “aria” in the attribute name. The reason is that role is based on the XHTML Role Attribute Module that was simply ported to HTML for simplicity.

    The text is added to the div element, and the div element is added to the document.

    The moment this happens, Firefox will fire an “alert” event to assistive technologies when this div appears. Most screen readers will pick this one up automatically and speak it. This is similar to the Notification Bar in Firefox that prompts you whether you want to save a password. Our one does not have any buttons to press, it just tells us what’s wrong.

    Adding the magic to the “onblur” event

    All that’s left now is add the event handler. We need to change the two inputs for e-mail and name for this:

     <input name="name" id="name" aria-required="true" 
            onblur="checkValidity('name', ' ', 'Invalid name entered!');"/>
     <br />
     <input name="email" id="email" aria-required="true" 
            onblur="checkValidity('email', '@', 'Invalid e-mail address');"/>
    

    Testing the example

    If you use Firefox 3 and a current supported screen reader, try the following:

    1. Enter only your first name as the name. When tabbing, you’ll hear an alert that tells you you’ve entered an invalid name. You can then shift-tab back and correct the error.
    2. Enter an e-mail address that has no “@” symbol. When tabbing out of this field, you should hear a warning that says you didn’t enter a valid e-mail address.

    In both cases, when returning focus to the field in question, your screen reader should tell you that this field is invalid. JAWS 9 supports this, but JAWS 8 does not, so this may not work in all versions of the screen readers supported.

    A few questions that you might have

    Q. Why did you put both “(required)” in the label text and the aria-required attribute on some of the inputs?
    A. If this were a real live form, and the site was being visited by a browser that does not yet support ARIA, we’d still want to give an indication that this is a required field.
    Q. Why don’t you set focus back to the invalid field automatically?
    A. Because this is not allowed by at least the Windows API specs and possibly others. Also, letting the focus jump around without real user interaction too often is not a nice thing to do in general. 
    TBD: let's rethink this -- personally, I think setting focus might be good if done without causing a keyboard trap.

    In conclusion

    Website accessibility is vastly improved when providing accessible alerts for client side validation. There’s nothing more frustrating for a user than filling out a form with 20 or so fields, submitting it, only to find that field 3 was invalid, and having to go through all fields again to make sure the values were retained, or supplying some information redundantly.

    Document Tags and Contributors

    Contributors to this page: Sheppy, Fredchat, Aaronlev, anastasia, lukecanvin
    Last updated by: Fredchat,