heading-has-content.js 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports["default"] = void 0;
  7. var _schemas = require("../util/schemas");
  8. var _getElementType = _interopRequireDefault(require("../util/getElementType"));
  9. var _hasAccessibleChild = _interopRequireDefault(require("../util/hasAccessibleChild"));
  10. var _isHiddenFromScreenReader = _interopRequireDefault(require("../util/isHiddenFromScreenReader"));
  11. /**
  12. * @fileoverview Enforce heading (h1, h2, etc) elements contain accessible content.
  13. * @author Ethan Cohen
  14. */
  15. // ----------------------------------------------------------------------------
  16. // Rule Definition
  17. // ----------------------------------------------------------------------------
  18. var errorMessage = 'Headings must have content and the content must be accessible by a screen reader.';
  19. var headings = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
  20. var schema = (0, _schemas.generateObjSchema)({
  21. components: _schemas.arraySchema
  22. });
  23. var _default = exports["default"] = {
  24. meta: {
  25. docs: {
  26. url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/heading-has-content.md',
  27. description: 'Enforce heading (`h1`, `h2`, etc) elements contain accessible content.'
  28. },
  29. schema: [schema]
  30. },
  31. create: function create(context) {
  32. var elementType = (0, _getElementType["default"])(context);
  33. return {
  34. JSXOpeningElement: function JSXOpeningElement(node) {
  35. var options = context.options[0] || {};
  36. var componentOptions = options.components || [];
  37. var typeCheck = headings.concat(componentOptions);
  38. var nodeType = elementType(node);
  39. // Only check 'h*' elements and custom types.
  40. if (typeCheck.indexOf(nodeType) === -1) {
  41. return;
  42. }
  43. if ((0, _hasAccessibleChild["default"])(node.parent, elementType)) {
  44. return;
  45. }
  46. if ((0, _isHiddenFromScreenReader["default"])(nodeType, node.attributes)) {
  47. return;
  48. }
  49. context.report({
  50. node,
  51. message: errorMessage
  52. });
  53. }
  54. };
  55. }
  56. };
  57. module.exports = exports.default;