github-pages-deploy-action/node_modules/eslint-plugin-jsx-a11y/docs/rules/no-interactive-element-to-noninteractive-role.md
2020-03-06 22:45:40 -05:00

2.3 KiB

no-interactive-element-to-noninteractive-role

Interactive HTML elements indicate controls in the user interface. Interactive elements include <a href>, <button>, <input>, <select>, <textarea>.

Non-interactive HTML elements and non-interactive ARIA roles indicate content and containers in the user interface. Non-interactive elements include <main>, <area>, <h1> (,<h2>, etc), <img>, <li>, <ul> and <ol>.

WAI-ARIA roles should not be used to convert an interactive element to a non-interactive element. Non-interactive ARIA roles include article, banner, complementary, img, listitem, main, region and tooltip.

How do I resolve this error?

Case: The element should be a container, like an article

Wrap your interactive element in a <div> with the desired role.

<div role="article">
  <button>Save</button>
</div>

Case: The element should be content, like an image

Put the content inside your interactive element.

<div
  role="button"
  onClick={() => {}}
  onKeyPress={() => {}}
  tabIndex="0">
  <div role="img" aria-label="Save" />
</div>

References

  1. WAI-ARIA roles
  2. WAI-ARIA Authoring Practices Guide - Design Patterns and Widgets
  3. Fundamental Keyboard Navigation Conventions
  4. Mozilla Developer Network - ARIA Techniques

Rule details

The recommended options for this rule allow the tr element to be given a role of presentation (or its semantic equivalent none). Under normal circumstances, an element with an interactive role should not be semantically neutralized with presentation (or none).

Options are provided as an object keyed by HTML element name; the value is an array of interactive roles that are allowed on the specified element.

{
  'no-interactive-element-to-noninteractive-role': [
    'error',
    {
      tr: ['none', 'presentation'],
    },
  ]
}

Under the recommended options, the following code is valid. It would be invalid under the strict rules.

<tr role="presentation" />