control-has-associated-label.js 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  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 _jsxAstUtils = require("jsx-ast-utils");
  8. var _arrayIncludes = _interopRequireDefault(require("array-includes"));
  9. var _schemas = require("../util/schemas");
  10. var _getElementType = _interopRequireDefault(require("../util/getElementType"));
  11. var _isDOMElement = _interopRequireDefault(require("../util/isDOMElement"));
  12. var _isHiddenFromScreenReader = _interopRequireDefault(require("../util/isHiddenFromScreenReader"));
  13. var _isInteractiveElement = _interopRequireDefault(require("../util/isInteractiveElement"));
  14. var _isInteractiveRole = _interopRequireDefault(require("../util/isInteractiveRole"));
  15. var _mayHaveAccessibleLabel = _interopRequireDefault(require("../util/mayHaveAccessibleLabel"));
  16. /**
  17. * @fileoverview Enforce controls are associated with a text label.
  18. * @author Jesse Beach
  19. *
  20. *
  21. */
  22. // ----------------------------------------------------------------------------
  23. // Rule Definition
  24. // ----------------------------------------------------------------------------
  25. var errorMessage = 'A control must be associated with a text label.';
  26. var ignoreList = ['link'];
  27. var schema = (0, _schemas.generateObjSchema)({
  28. labelAttributes: _schemas.arraySchema,
  29. controlComponents: _schemas.arraySchema,
  30. ignoreElements: _schemas.arraySchema,
  31. ignoreRoles: _schemas.arraySchema,
  32. depth: {
  33. description: 'JSX tree depth limit to check for accessible label',
  34. type: 'integer',
  35. minimum: 0
  36. }
  37. });
  38. var _default = exports["default"] = {
  39. meta: {
  40. docs: {
  41. description: 'Enforce that a control (an interactive element) has a text label.',
  42. url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/main/docs/rules/control-has-associated-label.md'
  43. },
  44. schema: [schema]
  45. },
  46. create: function create(context) {
  47. var elementType = (0, _getElementType["default"])(context);
  48. var options = context.options[0] || {};
  49. var _options$labelAttribu = options.labelAttributes,
  50. labelAttributes = _options$labelAttribu === void 0 ? [] : _options$labelAttribu,
  51. _options$controlCompo = options.controlComponents,
  52. controlComponents = _options$controlCompo === void 0 ? [] : _options$controlCompo,
  53. _options$ignoreElemen = options.ignoreElements,
  54. ignoreElements = _options$ignoreElemen === void 0 ? [] : _options$ignoreElemen,
  55. _options$ignoreRoles = options.ignoreRoles,
  56. ignoreRoles = _options$ignoreRoles === void 0 ? [] : _options$ignoreRoles;
  57. var newIgnoreElements = new Set([].concat(ignoreElements, ignoreList));
  58. var rule = function rule(node) {
  59. var tag = elementType(node.openingElement);
  60. var role = (0, _jsxAstUtils.getLiteralPropValue)((0, _jsxAstUtils.getProp)(node.openingElement.attributes, 'role'));
  61. // Ignore interactive elements that might get their label from a source
  62. // that cannot be discerned from static analysis, like
  63. // <label><input />Save</label>
  64. if (newIgnoreElements.has(tag)) {
  65. return;
  66. }
  67. // Ignore roles that are "interactive" but should not require a label.
  68. if ((0, _arrayIncludes["default"])(ignoreRoles, role)) {
  69. return;
  70. }
  71. var props = node.openingElement.attributes;
  72. var nodeIsDOMElement = (0, _isDOMElement["default"])(tag);
  73. var nodeIsHiddenFromScreenReader = (0, _isHiddenFromScreenReader["default"])(tag, props);
  74. var nodeIsInteractiveElement = (0, _isInteractiveElement["default"])(tag, props);
  75. var nodeIsInteractiveRole = (0, _isInteractiveRole["default"])(tag, props);
  76. var nodeIsControlComponent = controlComponents.indexOf(tag) > -1;
  77. if (nodeIsHiddenFromScreenReader) {
  78. return;
  79. }
  80. var hasAccessibleLabel = true;
  81. if (nodeIsInteractiveElement || nodeIsDOMElement && nodeIsInteractiveRole || nodeIsControlComponent) {
  82. // Prevent crazy recursion.
  83. var recursionDepth = Math.min(options.depth === undefined ? 2 : options.depth, 25);
  84. hasAccessibleLabel = (0, _mayHaveAccessibleLabel["default"])(node, recursionDepth, labelAttributes);
  85. }
  86. if (!hasAccessibleLabel) {
  87. context.report({
  88. node: node.openingElement,
  89. message: errorMessage
  90. });
  91. }
  92. };
  93. // Create visitor selectors.
  94. return {
  95. JSXElement: rule
  96. };
  97. }
  98. };
  99. module.exports = exports.default;