lighthouse-core/audits/accessibility/accesskeys.js

/**
 * @license Copyright 2017 Google Inc. All Rights Reserved.
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 */
'use strict';

/**
 * @fileoverview Ensures every accesskey attribute value is unique.
 * See base class in axe-audit.js for audit() implementation.
 */

const AxeAudit = require('./axe-audit');

class Accesskeys extends AxeAudit {
  /**
   * @return {!AuditMeta}
   */
  static get meta() {
    return {
      name: 'accesskeys',
      description: '`[accesskey]` values are unique.',
      failureDescription: '`[accesskey]` values are not unique.',
      helpText: 'Access keys let users quickly focus a part of the page. For proper ' +
          'navigation, each access key must be unique. ' +
          '[Learn more](https://dequeuniversity.com/rules/axe/2.2/accesskeys?application=lighthouse).',
      requiredArtifacts: ['Accessibility'],
    };
  }
}

module.exports = Accesskeys;