axe-core/lib/checks/aria/invalidrole-evaluate.js

Accessibility engine for automated Web UI testing

import { isValidRole } from '../../commons/aria';
import { tokenList } from '../../core/utils';

/**
 * Check that each role on an element is a valid ARIA role.
 *
 * Valid ARIA roles are listed in the `ariaRoles` standards object.
 *
 * ##### Data:
 * <table class="props">
 *   <thead>
 *     <tr>
 *       <th>Type</th>
 *       <th>Description</th>
 *     </tr>
 *   </thead>
 *   <tbody>
 *     <tr>
 *       <td><code>String[]</code></td>
 *       <td>List of all invalid roles</td>
 *     </tr>
 *   </tbody>
 * </table>
 *
 * @memberof checks
 * @return {Boolean} True if the element uses an invalid role. False otherwise.
 */
function invalidroleEvaluate(node, options, virtualNode) {
  const allRoles = tokenList(virtualNode.attr('role'));
  const allInvalid = allRoles.every(
    role => !isValidRole(role, { allowAbstract: true })
  );

  /**
   * Only fail when all the roles are invalid
   */
  if (allInvalid) {
    this.data(allRoles);
    return true;
  }

  return false;
}

export default invalidroleEvaluate;