axe-core 4.2.4 → 4.3.0

package/lib/checks/aria/aria-valid-attr-value-evaluate.js

@@ -1,122 +0,0 @@
-import { validateAttrValue } from '../../commons/aria';
-import { getNodeAttributes } from '../../core/utils';
-
-/**
- * Check that each ARIA attribute on an element has a valid value.
- *
- * Valid ARIA attribute values are taken from the `ariaAttrs` standards object from an attributes `type` property.
- *
- * ##### Data:
- * <table class="props">
- *   <thead>
- *     <tr>
- *       <th>Type</th>
- *       <th>Description</th>
- *     </tr>
- *   </thead>
- *   <tbody>
- *     <tr>
- *       <td><code>Mixed</code></td>
- *       <td>Object with Strings `messageKey` and `needsReview` if `aria-current` or `aria-describedby` are invalid. Otherwise a list of all invalid ARIA attributes and their value</td>
- *     </tr>
- *   </tbody>
- * </table>
- *
- * @memberof checks
- * @return {Mixed} True if all ARIA attributes have a valid value. Undefined for invalid `aria-current` or `aria-describedby` values. False otherwise.
- */
-function ariaValidAttrValueEvaluate(node, options) {
-  options = Array.isArray(options.value) ? options.value : [];
-
-  let needsReview = '';
-  let messageKey = '';
-  const invalid = [];
-  const aria = /^aria-/;
-  const attrs = getNodeAttributes(node);
-
-  const skipAttrs = ['aria-errormessage'];
-
-  const preChecks = {
-    // aria-controls should only check if element exists if the element
-    // doesn't have aria-expanded=false or aria-selected=false (tabs)
-    // @see https://github.com/dequelabs/axe-core/issues/1463
-    'aria-controls': () => {
-      return (
-        node.getAttribute('aria-expanded') !== 'false' &&
-        node.getAttribute('aria-selected') !== 'false'
-      );
-    },
-    // aria-current should mark as needs review if any value is used that is
-    // not one of the valid values (since any value is treated as "true")
-    'aria-current': () => {
-      if (!validateAttrValue(node, 'aria-current')) {
-        needsReview = `aria-current="${node.getAttribute('aria-current')}"`;
-        messageKey = 'ariaCurrent';
-      }
-
-      return;
-    },
-    // aria-owns should only check if element exists if the element
-    // doesn't have aria-expanded=false (combobox)
-    // @see https://github.com/dequelabs/axe-core/issues/1524
-    'aria-owns': () => {
-      return node.getAttribute('aria-expanded') !== 'false';
-    },
-    // aria-describedby should not mark missing element as violation but
-    // instead as needs review
-    // @see https://github.com/dequelabs/axe-core/issues/1151
-    'aria-describedby': () => {
-      if (!validateAttrValue(node, 'aria-describedby')) {
-        needsReview = `aria-describedby="${node.getAttribute(
-          'aria-describedby'
-        )}"`;
-        messageKey = 'noId';
-      }
-
-      return;
-    },
-    // aria-labelledby should not mark missing element as violation but
-    // instead as needs review
-    // @see https://github.com/dequelabs/axe-core/issues/2621
-    'aria-labelledby': () => {
-      if (!validateAttrValue(node, 'aria-labelledby')) {
-        needsReview = `aria-labelledby="${node.getAttribute(
-          'aria-labelledby'
-        )}"`;
-        messageKey = 'noId';
-      }
-    }
-  };
-
-  for (let i = 0, l = attrs.length; i < l; i++) {
-    const attr = attrs[i];
-    const attrName = attr.name;
-    // skip any attributes handled elsewhere
-    if (
-      !skipAttrs.includes(attrName) &&
-      options.indexOf(attrName) === -1 &&
-      aria.test(attrName) &&
-      (preChecks[attrName] ? preChecks[attrName]() : true) &&
-      !validateAttrValue(node, attrName)
-    ) {
-      invalid.push(`${attrName}="${attr.nodeValue}"`);
-    }
-  }
-
-  if (needsReview) {
-    this.data({
-      messageKey,
-      needsReview
-    });
-    return undefined;
-  }
-
-  if (invalid.length) {
-    this.data(invalid);
-    return false;
-  }
-
-  return true;
-}
-
-export default ariaValidAttrValueEvaluate;

package/lib/checks/aria/aria-valid-attr-value.json

@@ -1,19 +0,0 @@
-{
-  "id": "aria-valid-attr-value",
-  "evaluate": "aria-valid-attr-value-evaluate",
-  "options": [],
-  "metadata": {
-    "impact": "critical",
-    "messages": {
-      "pass": "ARIA attribute values are valid",
-      "fail": {
-        "singular": "Invalid ARIA attribute value: ${data.values}",
-        "plural": "Invalid ARIA attribute values: ${data.values}"
-      },
-      "incomplete": {
-        "noId": "ARIA attribute element ID does not exist on the page: ${data.needsReview}",
-        "ariaCurrent": "ARIA attribute value is invalid and will be treated as \"aria-current=true\": ${data.needsReview}"
-      }
-    }
-  }
-}

package/lib/checks/aria/aria-valid-attr.json

@@ -1,15 +0,0 @@
-{
-  "id": "aria-valid-attr",
-  "evaluate": "aria-valid-attr-evaluate",
-  "options": [],
-  "metadata": {
-    "impact": "critical",
-    "messages": {
-      "pass": "ARIA attribute name is valid",
-      "fail": {
-        "singular": "Invalid ARIA attribute name: ${data.values}",
-        "plural": "Invalid ARIA attribute names: ${data.values}"
-      }
-    }
-  }
-}

package/lib/checks/aria/fallbackrole-evaluate.js

@@ -1,13 +0,0 @@
-import { tokenList } from '../../core/utils';
-
-/**
- * Check that an element does not use more than one explicit role.
- *
- * @memberof checks
- * @return {Boolean} True if the element uses more than one explicit role. False otherwise.
- */
-function fallbackroleEvaluate(node, options, virtualNode) {
-  return tokenList(virtualNode.attr('role')).length > 1;
-}
-
-export default fallbackroleEvaluate;

package/lib/checks/aria/fallbackrole.json

@@ -1,11 +0,0 @@
-{
-  "id": "fallbackrole",
-  "evaluate": "fallbackrole-evaluate",
-  "metadata": {
-    "impact": "serious",
-    "messages": {
-      "pass": "Only one role value used",
-      "fail": "Use only one role value, since fallback roles are not supported in older browsers"
-    }
-  }
-}

package/lib/checks/aria/has-global-aria-attribute-evaluate.js

@@ -1,11 +0,0 @@
-import getGlobalAriaAttrs from '../../commons/standards/get-global-aria-attrs';
-
-function hasGlobalAriaAttributeEvaluate(node, options, virtualNode) {
-  const globalAttrs = getGlobalAriaAttrs().filter(attr =>
-    virtualNode.hasAttr(attr)
-  );
-  this.data(globalAttrs);
-  return globalAttrs.length > 0;
-}
-
-export default hasGlobalAriaAttributeEvaluate;

package/lib/checks/aria/has-global-aria-attribute.json

@@ -1,14 +0,0 @@
-{
-  "id": "has-global-aria-attribute",
-  "evaluate": "has-global-aria-attribute-evaluate",
-  "metadata": {
-    "impact": "minor",
-    "messages": {
-      "pass": {
-        "singular": "Element has global ARIA attribute: ${data.values}",
-        "plural": "Element has global ARIA attributes: ${data.values}"
-      },
-      "fail": "Element does not have global ARIA attribute"
-    }
-  }
-}

package/lib/checks/aria/has-widget-role-evaluate.js

@@ -1,20 +0,0 @@
-import { getRoleType } from '../../commons/aria';
-
-/**
- * Check if an elements `role` attribute uses any widget or composite role values.
- *
- * Widget roles are taken from the `ariaRoles` standards object from the roles `type` property.
- *
- * @memberof checks
- * @return {Boolean} True if the element uses a `widget` or `composite` role. False otherwise.
- */
-function hasWidgetRoleEvaluate(node) {
-  const role = node.getAttribute('role');
-  if (role === null) {
-    return false;
-  }
-  const roleType = getRoleType(role);
-  return roleType === 'widget' || roleType === 'composite';
-}
-
-export default hasWidgetRoleEvaluate;

package/lib/checks/aria/has-widget-role.json

@@ -1,12 +0,0 @@
-{
-  "id": "has-widget-role",
-  "evaluate": "has-widget-role-evaluate",
-  "options": [],
-  "metadata": {
-    "impact": "minor",
-    "messages": {
-      "pass": "Element has a widget role.",
-      "fail": "Element does not have a widget role."
-    }
-  }
-}

package/lib/checks/aria/invalidrole-evaluate.js

@@ -1,45 +0,0 @@
-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;

package/lib/checks/aria/invalidrole.json

@@ -1,14 +0,0 @@
-{
-  "id": "invalidrole",
-  "evaluate": "invalidrole-evaluate",
-  "metadata": {
-    "impact": "critical",
-    "messages": {
-      "pass": "ARIA role is valid",
-      "fail": {
-        "singular": "Role must be one of the valid ARIA roles: ${data.values}",
-        "plural": "Roles must be one of the valid ARIA roles: ${data.values}"
-      }
-    }
-  }
-}

package/lib/checks/aria/is-element-focusable-evaluate.js

@@ -1,7 +0,0 @@
-import { isFocusable } from '../../commons/dom';
-
-function isElementFocusableEvaluate(node, options, virtualNode) {
-  return isFocusable(virtualNode);
-}
-
-export default isElementFocusableEvaluate;

package/lib/checks/aria/is-element-focusable.json

@@ -1,11 +0,0 @@
-{
-  "id": "is-element-focusable",
-  "evaluate": "is-element-focusable-evaluate",
-  "metadata": {
-    "impact": "minor",
-    "messages": {
-      "pass": "Element is focusable.",
-      "fail": "Element is not focusable."
-    }
-  }
-}

package/lib/checks/aria/no-implicit-explicit-label-evaluate.js

@@ -1,54 +0,0 @@
-import { getRole } from '../../commons/aria';
-import { sanitize, labelText, accessibleTextVirtual } from '../../commons/text';
-
-/**
- * Check that an elements explicit label matches its accessible name.
- *
- * ##### Data:
- * <table class="props">
- *   <thead>
- *     <tr>
- *       <th>Type</th>
- *       <th>Description</th>
- *     </tr>
- *   </thead>
- *   <tbody>
- *     <tr>
- *       <td><code>String</code></td>
- *       <td>The elements explicit role</td>
- *     </tr>
- *   </tbody>
- * </table>
- *
- * @memberof checks
- * @return {Mixed} False if the element does not have an explicit label and accessible name or if there is no mismatch between them. Undefined if the element has an explicit label but no accessible name or if the accessible name does not include the label text.
- */
-function noImplicitExplicitLabelEvaluate(node, options, virtualNode) {
-  const role = getRole(virtualNode, { noImplicit: true });
-  this.data(role);
-
-  let label;
-  let accText;
-  try {
-    label = sanitize(labelText(virtualNode)).toLowerCase();
-    accText = sanitize(accessibleTextVirtual(virtualNode)).toLowerCase();
-  } catch (e) {
-    return undefined;
-  }
-
-  if (!accText && !label) {
-    return false;
-  }
-
-  if (!accText && label) {
-    return undefined;
-  }
-
-  if (!accText.includes(label)) {
-    return undefined;
-  }
-
-  return false;
-}
-
-export default noImplicitExplicitLabelEvaluate;

package/lib/checks/aria/no-implicit-explicit-label.json

@@ -1,11 +0,0 @@
-{
-  "id": "no-implicit-explicit-label",
-  "evaluate": "no-implicit-explicit-label-evaluate",
-  "metadata": {
-    "impact": "moderate",
-    "messages": {
-      "pass": "There is no mismatch between a <label> and accessible name",
-      "incomplete": "Check that the <label> does not need be part of the ARIA ${data} field's name"
-    }
-  }
-}

package/lib/checks/aria/unsupportedrole-evaluate.js

@@ -1,15 +0,0 @@
-import { isUnsupportedRole, getRole } from '../../commons/aria';
-
-/**
- * Check that an elements semantic role is unsupported.
- *
- * Unsupported roles are taken from the `ariaRoles` standards object from the roles `unsupported` property.
- *
- * @memberof checks
- * @return {Boolean} True if the elements semantic role is unsupported. False otherwise.
- */
-function unsupportedroleEvaluate(node, options, virtualNode) {
-  return isUnsupportedRole(getRole(virtualNode));
-}
-
-export default unsupportedroleEvaluate;

package/lib/checks/aria/unsupportedrole.json

@@ -1,11 +0,0 @@
-{
-  "id": "unsupportedrole",
-  "evaluate": "unsupportedrole-evaluate",
-  "metadata": {
-    "impact": "critical",
-    "messages": {
-      "pass": "ARIA role is supported",
-      "fail": "The role used is not widely supported in screen readers and assistive technologies: ${data.values}"
-    }
-  }
-}

package/lib/checks/aria/valid-scrollable-semantics-evaluate.js

@@ -1,70 +0,0 @@
-import { getExplicitRole } from '../../commons/aria';
-
-/**
- * A map from HTML tag names to a boolean which reflects whether it is
- * appropriate for scrollable elements found in the focus order.
- */
-const VALID_TAG_NAMES_FOR_SCROLLABLE_REGIONS = {
-  ARTICLE: true,
-  ASIDE: true,
-  NAV: true,
-  SECTION: true
-};
-
-/**
- * A map from each landmark role to a boolean which reflects whether it is
- * appropriate for scrollable elements found in the focus order.
- */
-const VALID_ROLES_FOR_SCROLLABLE_REGIONS = {
-  application: true,
-  banner: false,
-  complementary: true,
-  contentinfo: true,
-  form: true,
-  main: true,
-  navigation: true,
-  region: true,
-  search: false
-};
-
-/**
- * @param {HTMLElement} node
- * @return {Boolean} Whether the element has a tag appropriate for a scrollable
- *		 region.
- */
-function validScrollableTagName(node) {
-  // Some elements with nonsensical roles will pass this check, but should be
-  // flagged by other checks.
-  const nodeName = node.nodeName.toUpperCase();
-  return VALID_TAG_NAMES_FOR_SCROLLABLE_REGIONS[nodeName] || false;
-}
-
-/**
- * @param {HTMLElement} node
- * @return {Boolean} Whether the node has a role appropriate for a scrollable
- *		 region.
- */
-function validScrollableRole(node, options) {
-  var role = getExplicitRole(node);
-  if (!role) {
-    return false;
-  }
-  return (
-    VALID_ROLES_FOR_SCROLLABLE_REGIONS[role] ||
-    options.roles.includes(role) ||
-    false
-  );
-}
-
-/**
- * Check if the element has a valid scrollable role or tag.
- *
- * @memberof checks
- * @param {HTMLElement} node
- * @return {Boolean} True if the elements role or tag name is a valid scrollable region. False otherwise.
- */
-function validScrollableSemanticsEvaluate(node, options) {
-  return validScrollableRole(node, options) || validScrollableTagName(node);
-}
-
-export default validScrollableSemanticsEvaluate;

package/lib/checks/aria/valid-scrollable-semantics.json

@@ -1,14 +0,0 @@
-{
-  "id": "valid-scrollable-semantics",
-  "evaluate": "valid-scrollable-semantics-evaluate",
-  "options": {
-    "roles": ["tooltip"]
-  },
-  "metadata": {
-    "impact": "minor",
-    "messages": {
-      "pass": "Element has valid semantics for an element in the focus order.",
-      "fail": "Element has invalid semantics for an element in the focus order."
-    }
-  }
-}