no-autofocus.js 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  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 _ariaQuery = require("aria-query");
  9. var _schemas = require("../util/schemas");
  10. var _getElementType = _interopRequireDefault(require("../util/getElementType"));
  11. /**
  12. * @fileoverview Enforce autoFocus prop is not used.
  13. * @author Ethan Cohen <@evcohen>
  14. */
  15. // ----------------------------------------------------------------------------
  16. // Rule Definition
  17. // ----------------------------------------------------------------------------
  18. var errorMessage = 'The autoFocus prop should not be used, as it can reduce usability and accessibility for users.';
  19. var schema = (0, _schemas.generateObjSchema)({
  20. ignoreNonDOM: {
  21. type: 'boolean',
  22. "default": false
  23. }
  24. });
  25. var _default = exports["default"] = {
  26. meta: {
  27. docs: {
  28. url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-autofocus.md',
  29. description: 'Enforce autoFocus prop is not used.'
  30. },
  31. schema: [schema]
  32. },
  33. create: function create(context) {
  34. var elementType = (0, _getElementType["default"])(context);
  35. return {
  36. JSXAttribute: function JSXAttribute(attribute) {
  37. // Determine if ignoreNonDOM is set to true
  38. // If true, then do not run rule.
  39. var options = context.options[0] || {};
  40. var ignoreNonDOM = !!options.ignoreNonDOM;
  41. if (ignoreNonDOM) {
  42. var type = elementType(attribute.parent);
  43. if (!_ariaQuery.dom.get(type)) {
  44. return;
  45. }
  46. }
  47. // Don't normalize, since React only recognizes autoFocus on low-level DOM elements.
  48. if ((0, _jsxAstUtils.propName)(attribute) === 'autoFocus') {
  49. context.report({
  50. node: attribute,
  51. message: errorMessage
  52. });
  53. }
  54. }
  55. };
  56. }
  57. };
  58. module.exports = exports.default;