no-noninteractive-tabindex.js 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  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 _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
  8. var _ariaQuery = require("aria-query");
  9. var _jsxAstUtils = require("jsx-ast-utils");
  10. var _arrayIncludes = _interopRequireDefault(require("array-includes"));
  11. var _getElementType = _interopRequireDefault(require("../util/getElementType"));
  12. var _isInteractiveElement = _interopRequireDefault(require("../util/isInteractiveElement"));
  13. var _isInteractiveRole = _interopRequireDefault(require("../util/isInteractiveRole"));
  14. var _isNonLiteralProperty = _interopRequireDefault(require("../util/isNonLiteralProperty"));
  15. var _schemas = require("../util/schemas");
  16. var _getTabIndex = _interopRequireDefault(require("../util/getTabIndex"));
  17. function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
  18. function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
  19. var errorMessage = '`tabIndex` should only be declared on interactive elements.';
  20. var schema = (0, _schemas.generateObjSchema)({
  21. roles: _objectSpread(_objectSpread({}, _schemas.arraySchema), {}, {
  22. description: 'An array of ARIA roles'
  23. }),
  24. tags: _objectSpread(_objectSpread({}, _schemas.arraySchema), {}, {
  25. description: 'An array of HTML tag names'
  26. })
  27. });
  28. var _default = {
  29. meta: {
  30. docs: {
  31. url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-noninteractive-tabindex.md',
  32. description: '`tabIndex` should only be declared on interactive elements.',
  33. errorOptions: true
  34. },
  35. schema: [schema]
  36. },
  37. create: function create(context) {
  38. var options = context.options;
  39. var elementType = (0, _getElementType["default"])(context);
  40. return {
  41. JSXOpeningElement: function JSXOpeningElement(node) {
  42. var type = elementType(node);
  43. var attributes = node.attributes;
  44. var tabIndexProp = (0, _jsxAstUtils.getProp)(attributes, 'tabIndex');
  45. var tabIndex = (0, _getTabIndex["default"])(tabIndexProp); // Early return;
  46. if (typeof tabIndex === 'undefined') {
  47. return;
  48. }
  49. var role = (0, _jsxAstUtils.getLiteralPropValue)((0, _jsxAstUtils.getProp)(node.attributes, 'role'));
  50. if (!_ariaQuery.dom.has(type)) {
  51. // Do not test higher level JSX components, as we do not know what
  52. // low-level DOM element this maps to.
  53. return;
  54. } // Allow for configuration overrides.
  55. var _ref = options[0] || {},
  56. tags = _ref.tags,
  57. roles = _ref.roles,
  58. allowExpressionValues = _ref.allowExpressionValues;
  59. if (tags && (0, _arrayIncludes["default"])(tags, type)) {
  60. return;
  61. }
  62. if (roles && (0, _arrayIncludes["default"])(roles, role)) {
  63. return;
  64. }
  65. if (allowExpressionValues === true && (0, _isNonLiteralProperty["default"])(attributes, 'role')) {
  66. // Special case if role is assigned using ternary with literals on both side
  67. var roleProp = (0, _jsxAstUtils.getProp)(attributes, 'role');
  68. if (roleProp && roleProp.type === 'JSXAttribute' && roleProp.value.type === 'JSXExpressionContainer') {
  69. if (roleProp.value.expression.type === 'ConditionalExpression') {
  70. if (roleProp.value.expression.consequent.type === 'Literal' && roleProp.value.expression.alternate.type === 'Literal') {
  71. return;
  72. }
  73. }
  74. }
  75. return;
  76. }
  77. if ((0, _isInteractiveElement["default"])(type, attributes) || (0, _isInteractiveRole["default"])(type, attributes)) {
  78. return;
  79. }
  80. if (tabIndex >= 0) {
  81. context.report({
  82. node: tabIndexProp,
  83. message: errorMessage
  84. });
  85. }
  86. }
  87. };
  88. }
  89. };
  90. exports["default"] = _default;
  91. module.exports = exports.default;