no-noninteractive-tabindex.js 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports["default"] = void 0;
  6. var _ariaQuery = require("aria-query");
  7. var _jsxAstUtils = require("jsx-ast-utils");
  8. var _arrayIncludes = _interopRequireDefault(require("array-includes"));
  9. var _getElementType = _interopRequireDefault(require("../util/getElementType"));
  10. var _isInteractiveElement = _interopRequireDefault(require("../util/isInteractiveElement"));
  11. var _isInteractiveRole = _interopRequireDefault(require("../util/isInteractiveRole"));
  12. var _isNonLiteralProperty = _interopRequireDefault(require("../util/isNonLiteralProperty"));
  13. var _schemas = require("../util/schemas");
  14. var _getTabIndex = _interopRequireDefault(require("../util/getTabIndex"));
  15. function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
  16. function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
  17. function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
  18. function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
  19. function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
  20. function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
  21. * @fileoverview Disallow tabindex on static and noninteractive elements
  22. * @author jessebeach
  23. *
  24. */ // ----------------------------------------------------------------------------
  25. // Rule Definition
  26. // ----------------------------------------------------------------------------
  27. var errorMessage = '`tabIndex` should only be declared on interactive elements.';
  28. var schema = (0, _schemas.generateObjSchema)({
  29. roles: _objectSpread(_objectSpread({}, _schemas.arraySchema), {}, {
  30. description: 'An array of ARIA roles'
  31. }),
  32. tags: _objectSpread(_objectSpread({}, _schemas.arraySchema), {}, {
  33. description: 'An array of HTML tag names'
  34. })
  35. });
  36. var _default = exports["default"] = {
  37. meta: {
  38. docs: {
  39. url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-noninteractive-tabindex.md',
  40. description: '`tabIndex` should only be declared on interactive elements.'
  41. },
  42. schema: [schema]
  43. },
  44. create: function create(context) {
  45. var options = context.options;
  46. var elementType = (0, _getElementType["default"])(context);
  47. return {
  48. JSXOpeningElement: function (_JSXOpeningElement) {
  49. function JSXOpeningElement(_x) {
  50. return _JSXOpeningElement.apply(this, arguments);
  51. }
  52. JSXOpeningElement.toString = function () {
  53. return _JSXOpeningElement.toString();
  54. };
  55. return JSXOpeningElement;
  56. }(function (node) {
  57. var type = elementType(node);
  58. var attributes = node.attributes;
  59. var tabIndexProp = (0, _jsxAstUtils.getProp)(attributes, 'tabIndex');
  60. var tabIndex = (0, _getTabIndex["default"])(tabIndexProp);
  61. // Early return;
  62. if (typeof tabIndex === 'undefined') {
  63. return;
  64. }
  65. var role = (0, _jsxAstUtils.getLiteralPropValue)((0, _jsxAstUtils.getProp)(node.attributes, 'role'));
  66. if (!_ariaQuery.dom.has(type)) {
  67. // Do not test higher level JSX components, as we do not know what
  68. // low-level DOM element this maps to.
  69. return;
  70. }
  71. // Allow for configuration overrides.
  72. var _ref = options[0] || {},
  73. tags = _ref.tags,
  74. roles = _ref.roles,
  75. allowExpressionValues = _ref.allowExpressionValues;
  76. if (tags && (0, _arrayIncludes["default"])(tags, type)) {
  77. return;
  78. }
  79. if (roles && (0, _arrayIncludes["default"])(roles, role)) {
  80. return;
  81. }
  82. if (allowExpressionValues === true && (0, _isNonLiteralProperty["default"])(attributes, 'role')) {
  83. // Special case if role is assigned using ternary with literals on both side
  84. var roleProp = (0, _jsxAstUtils.getProp)(attributes, 'role');
  85. if (roleProp && roleProp.type === 'JSXAttribute' && roleProp.value.type === 'JSXExpressionContainer') {
  86. if (roleProp.value.expression.type === 'ConditionalExpression') {
  87. if (roleProp.value.expression.consequent.type === 'Literal' && roleProp.value.expression.alternate.type === 'Literal') {
  88. return;
  89. }
  90. }
  91. }
  92. return;
  93. }
  94. if ((0, _isInteractiveElement["default"])(type, attributes) || (0, _isInteractiveRole["default"])(type, attributes)) {
  95. return;
  96. }
  97. if (tabIndex >= 0) {
  98. context.report({
  99. node: tabIndexProp,
  100. message: errorMessage
  101. });
  102. }
  103. })
  104. };
  105. }
  106. };
  107. module.exports = exports.default;