no-invalid-role.md

no-invalid-role

✅ The extends: 'recommended' property in a configuration file enables this rule.

This rule checks for invalid element/role combinations.

Current list of checks:

1. Use of the presentation role for content which should convey semantic information may prevent the user from understanding that content. This rule checks semantic HTML elements for the presence of role="none" or role="presentation" and compares it to the list of disallowed elements. It should not effect custom elements.

2. Use of invalid role for elements which does not fall under any of the values in this list.

Examples

This rule forbids the following:

<table role="presentation">
</table>

<ul role="none">
</ul>

<div role="accordion"></div>

<div role="command interface"></div>

<div role="COMMAND INTERFACE"></div>

This rule allows the following:

<img role="presentation" alt="">

<span role="none"></span>

Configuration

• boolean - true to enable / false to disable

• object - { 'catchNonexistentRoles' : true|false } -- Whether invalid role values should be allowed (defaults to false) (TODO: change default to true in next major release)

Migration

• If violations are found, remediation should be planned to replace the semantic HTML with the div element. Additional CSS will likely be required.

References

• HTML elements reference
• WAI-ARIA presentation(role)
• Failure of Success Criterion 1.3.1 due to the use of role presentation on content which conveys semantic information
• The Role Model