jsx-a11y/media-has-caption Correctness
What it does
Checks if <audio> and <video> elements have a <track> element for captions. This ensures media content is accessible to all users, including those with hearing impairments.
Why is this bad?
Without captions, audio and video content is not accessible to users who are deaf or hard of hearing. Captions are also useful for users in noisy environments or where audio is not available.
Examples
Examples of incorrect code for this rule:
<audio></audio>
<video></video>Examples of correct code for this rule:
<audio><track kind="captions" src="caption_file.vtt" /></audio>
<video><track kind="captions" src="caption_file.vtt" /></video>Configuration
This rule accepts a configuration object with the following properties:
audio
type: string[]
default: ["audio"]
Element names to treat as <audio> elements
track
type: string[]
default: ["track"]
Element names to treat as <track> elements
video
type: string[]
default: ["video"]
Element names to treat as <video> elements
How to use
To enable this rule using the config file or in the CLI, you can use:
{
"plugins": ["jsx-a11y"],
"rules": {
"jsx-a11y/media-has-caption": "error"
}
}import { defineConfig } from "oxlint";
export default defineConfig({
plugins: ["jsx-a11y"],
rules: {
"jsx-a11y/media-has-caption": "error",
},
});oxlint --deny jsx-a11y/media-has-caption --jsx-a11y-pluginVersion
This rule was added in v0.1.1.