New
Introducing React Bench, see how different models perform on React code

react-doctor/role-has-required-aria-props

Require elements with an ARIA role to carry that role's required aria-* state props, like aria-checked on role='checkbox'.

Status
Active
Category
Accessibility
Assessment
Evidence-required risk
Required evidence
source code, rendered UI, accessibility audit
Default configuration
Enabled
Default severity
error
Show technical metadata
Scope
All supported frameworks
Active when
always (unless customRulesOnly=true)
Requirements
react
Tags
react-jsx-only
Priority
88 (P0)
Source
oxlint-plugin-react-doctor
Rule set
oxlint-plugin-react-doctor 0.9.3 (prompt schema 2)
On this page

Validation prompt

Confirm the detector match and collect the required evidence before deciding whether an edit is warranted.

Fires on a JSXOpeningElement whose 'role' is one of a fixed set and is missing ANY of that role's required aria-* (checkbox/radio/switch/menuitemcheckbox/menuitemradio -> 'aria-checked'; option -> 'aria-selected'; heading -> 'aria-level'; combobox/scrollbar -> 'aria-controls' AND ('aria-expanded' | 'aria-valuenow'); slider/meter -> 'aria-valuenow'). It reports each individually missing prop, so a role with SOME (e.g. combobox with only 'aria-expanded', missing 'aria-controls') still fires legitimately. Confirm whenever the role sits on a non-semantic element (div, span, custom component, or button) that has no implicit state. THE ONE FALSE POSITIVE: the role overrides a NATIVE element whose implicit HTML semantics already expose that exact state to the a11y tree -- role='switch'/'checkbox' on '<input type=checkbox checked={...}>', role='radio' on '<input type=radio>', role='option' on '<option>'. There the native 'checked'/'selected' DOM property supplies the state and explicit aria-* is redundant (and can desync). Suppress only that native-backing case. Imperative aria-* added in a useEffect/ref the static JSX can't see is also a (rarer) suppress.

Evidence boundary

The diagnostic proves only that the detector’s modeled source pattern matched. It does not prove runtime impact, product intent, rendered failure, or that one remediation is correct.

Establish the environment, repository policy, exceptions, and required rendered or runtime evidence before deciding the occurrence.

Record one outcome:

  • Confirmed failure: The required evidence establishes the violation.
  • Rejected: A documented exception or false-positive predicate applies.
  • Needs evidence: Named evidence can still be collected.
  • Unavailable: Required evidence cannot be collected in this run.
  • Waived with evidence: An authorized, scoped exception applies to an established failure.
  • Observation: The review records an optional tradeoff without claiming a defect.

A waiver records its scope, authority, evidence, and review condition. It is not a pass or false positive.

Default severity is registry metadata. Use the occurrence’s JSON severity after repository configuration when ordering real findings.

Fix prompt

Apply this candidate correction only after the required evidence confirms the risk.

Principle: every role in this rule's set is a state-bearing widget; assistive tech needs the value, so SUPPLY THE MISSING STATE, do not just silence the lint. (A) Best: drop the explicit role and use the native element that owns the semantics -- '<input type=checkbox checked={on}>' for switch/checkbox, '<input type=radio>' for radio, native '<option>' for option, real '<h1..h6>' for heading; the browser then exposes checked/selected/level automatically. (B) If a custom role must stay (styling, headless lib), bind the required aria-* to the live state, never a constant: 'aria-checked={isOn}' for checkbox/radio/switch, 'aria-selected={isHighlighted}' for option, 'aria-valuenow={value}' (add valuemin/valuemax for usable sliders) for slider/meter, 'aria-level={2}' for heading, and BOTH 'aria-controls={listId}' and 'aria-expanded={open}' for combobox -- the rule wants every listed prop, so add all it names. Anti-pattern: hardcoding 'aria-checked={false}' or 'aria-selected={true}' to mute the rule -- that lies to screen readers; wire it to the same prop/state driving the visual (the 'checked'/'value'/'open' already in scope). See https://oxc.rs/docs/guide/usage/linter/rules/jsx_a11y/role-has-required-aria-props

Repository-wide copy prompt

Use this repository-wide prompt only after validating each occurrence. For one occurrence, use the guidance above.

Show repository-wide prompt

Fix every confirmed react-doctor/role-has-required-aria-props diagnostic in the current repository.

Required change:

  • Principle: every role in this rule's set is a state-bearing widget; assistive tech needs the value, so SUPPLY THE MISSING STATE, do not just silence the lint. (A) Best: drop the explicit role and use the native element that owns the semantics -- '<input type=checkbox checked={on}>' for switch/checkbox, '<input type=radio>' for radio, native '<option>' for option, real '<h1..h6>' for heading; the browser then exposes checked/selected/level automatically. (B) If a custom role must stay (styling, headless lib), bind the required aria-* to the live state, never a constant: 'aria-checked={isOn}' for checkbox/radio/switch, 'aria-selected={isHighlighted}' for option, 'aria-valuenow={value}' (add valuemin/valuemax for usable sliders) for slider/meter, 'aria-level={2}' for heading, and BOTH 'aria-controls={listId}' and 'aria-expanded={open}' for combobox -- the rule wants every listed prop, so add all it names. Anti-pattern: hardcoding 'aria-checked={false}' or 'aria-selected={true}' to mute the rule -- that lies to screen readers; wire it to the same prop/state driving the visual (the 'checked'/'value'/'open' already in scope). See https://oxc.rs/docs/guide/usage/linter/rules/jsx_a11y/role-has-required-aria-props.

Validation before editing:

Fires on a JSXOpeningElement whose 'role' is one of a fixed set and is missing ANY of that role's required aria-* (checkbox/radio/switch/menuitemcheckbox/menuitemradio -> 'aria-checked'; option -> 'aria-selected'; heading -> 'aria-level'; combobox/scrollbar -> 'aria-controls' AND ('aria-expanded' | 'aria-valuenow'); slider/meter -> 'aria-valuenow'). It reports each individually missing prop, so a role with SOME (e.g. combobox with only 'aria-expanded', missing 'aria-controls') still fires legitimately. Confirm whenever the role sits on a non-semantic element (div, span, custom component, or button) that has no implicit state. THE ONE FALSE POSITIVE: the role overrides a NATIVE element whose implicit HTML semantics already expose that exact state to the a11y tree -- role='switch'/'checkbox' on '<input type=checkbox checked={...}>', role='radio' on '<input type=radio>', role='option' on '<option>'. There the native 'checked'/'selected' DOM property supplies the state and explicit aria-* is redundant (and can desync). Suppress only that native-backing case. Imperative aria-* added in a useEffect/ref the static JSX can't see is also a (rarer) suppress.

Constraints:

  • Make the smallest change that fixes the root cause.
  • Preserve behavior and interfaces unrelated to this diagnostic.
  • Reuse existing project components, utilities, and conventions.
  • Do not introduce render-phase side effects, render-phase state updates, or Hooks rule violations.
  • Preserve accessible names, focus order, keyboard behavior, and touch access not targeted by this rule.
  • Adapt identifiers and framework details instead of copying blindly.
  • Do not disable the rule or suppress matching code.
  • Confirm this rule is enabled for the project: always (unless customRulesOnly=true).

Assessment:

  • Record detector evidence, applicability facts, assumptions, missing evidence, and the rule class for this occurrence.
  • Return one outcome: Confirmed failure, Rejected, Needs evidence, Unavailable, Waived with evidence, or Observation.
  • A waiver records the established failure, scope, authority, evidence, and review or expiry condition. It is not a pass or false positive.

Verification:

  • Run focused tests for the changed behavior.
  • Run React Doctor and confirm this diagnostic no longer appears from changed code.
  • Run an unfiltered scan of the affected scope before claiming no cross-category regression.
  • Report the files changed and any checks you could not run.