| 1 | "use strict";
|
|---|
| 2 |
|
|---|
| 3 | Object.defineProperty(exports, "__esModule", {
|
|---|
| 4 | value: true
|
|---|
| 5 | });
|
|---|
| 6 | exports["default"] = void 0;
|
|---|
| 7 | var _ariaQuery = require("aria-query");
|
|---|
| 8 | var _jsxAstUtils = require("jsx-ast-utils");
|
|---|
| 9 | var _schemas = require("../util/schemas");
|
|---|
| 10 | var _getElementType = _interopRequireDefault(require("../util/getElementType"));
|
|---|
| 11 | var _isHiddenFromScreenReader = _interopRequireDefault(require("../util/isHiddenFromScreenReader"));
|
|---|
| 12 | var _isInteractiveElement = _interopRequireDefault(require("../util/isInteractiveElement"));
|
|---|
| 13 | var _isPresentationRole = _interopRequireDefault(require("../util/isPresentationRole"));
|
|---|
| 14 | function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|---|
| 15 | /**
|
|---|
| 16 | * @fileoverview Enforce a clickable non-interactive element has at least 1 keyboard event listener.
|
|---|
| 17 | * @author Ethan Cohen
|
|---|
| 18 | */
|
|---|
| 19 |
|
|---|
| 20 | // ----------------------------------------------------------------------------
|
|---|
| 21 | // Rule Definition
|
|---|
| 22 | // ----------------------------------------------------------------------------
|
|---|
| 23 |
|
|---|
| 24 | var errorMessage = 'Visible, non-interactive elements with click handlers must have at least one keyboard listener.';
|
|---|
| 25 | var schema = (0, _schemas.generateObjSchema)();
|
|---|
| 26 | var _default = exports["default"] = {
|
|---|
| 27 | meta: {
|
|---|
| 28 | docs: {
|
|---|
| 29 | url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/click-events-have-key-events.md',
|
|---|
| 30 | description: 'Enforce a clickable non-interactive element has at least one keyboard event listener.'
|
|---|
| 31 | },
|
|---|
| 32 | schema: [schema]
|
|---|
| 33 | },
|
|---|
| 34 | create: function create(context) {
|
|---|
| 35 | var elementType = (0, _getElementType["default"])(context);
|
|---|
| 36 | return {
|
|---|
| 37 | JSXOpeningElement: function JSXOpeningElement(node) {
|
|---|
| 38 | var props = node.attributes;
|
|---|
| 39 | if ((0, _jsxAstUtils.getProp)(props, 'onclick') === undefined) {
|
|---|
| 40 | return;
|
|---|
| 41 | }
|
|---|
| 42 | var type = elementType(node);
|
|---|
| 43 | var requiredProps = ['onkeydown', 'onkeyup', 'onkeypress'];
|
|---|
| 44 | if (!_ariaQuery.dom.has(type)) {
|
|---|
| 45 | // Do not test higher level JSX components, as we do not know what
|
|---|
| 46 | // low-level DOM element this maps to.
|
|---|
| 47 | return;
|
|---|
| 48 | }
|
|---|
| 49 | if ((0, _isHiddenFromScreenReader["default"])(type, props) || (0, _isPresentationRole["default"])(type, props)) {
|
|---|
| 50 | return;
|
|---|
| 51 | }
|
|---|
| 52 | if ((0, _isInteractiveElement["default"])(type, props)) {
|
|---|
| 53 | return;
|
|---|
| 54 | }
|
|---|
| 55 | if ((0, _jsxAstUtils.hasAnyProp)(props, requiredProps)) {
|
|---|
| 56 | return;
|
|---|
| 57 | }
|
|---|
| 58 |
|
|---|
| 59 | // Visible, non-interactive elements with click handlers require one keyboard event listener.
|
|---|
| 60 | context.report({
|
|---|
| 61 | node,
|
|---|
| 62 | message: errorMessage
|
|---|
| 63 | });
|
|---|
| 64 | }
|
|---|
| 65 | };
|
|---|
| 66 | }
|
|---|
| 67 | };
|
|---|
| 68 | module.exports = exports.default; |
|---|