lighthouse-core/audits/accessibility/button-name.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 buttons have discernible text.
 * See base class in axe-audit.js for audit() implementation.
 */

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

class ButtonName extends AxeAudit {
  /**
   * @return {!AuditMeta}
   */
  static get meta() {
    return {
      name: 'button-name',
      description: 'Buttons have an accessible name.',
      failureDescription: 'Buttons do not have an accessible name.',
      helpText: 'When a button doesn\'t have an accessible name, screen readers announce it as ' +
          '"button", making it unusable for users who rely on screen readers. ' +
          '[Learn more](https://dequeuniversity.com/rules/axe/2.2/button-name?application=lighthouse).',
      requiredArtifacts: ['Accessibility'],
    };
  }
}

module.exports = ButtonName;