useMediaCaption
Summary
Section titled “Summary”- Rule available since:
v1.0.0 - Diagnostic Category:
lint/a11y/useMediaCaption - This rule is recommended, which means is enabled by default.
- This rule doesn’t have a fix.
- The default severity of this rule is error.
- Sources:
- Same as
jsx-a11y/media-has-caption
- Same as
How to configure
Section titled “How to configure”{ "linter": { "rules": { "a11y": { "useMediaCaption": "error" } } }}Description
Section titled “Description”Enforces that audio and video elements must have a track for captions.
Examples
Section titled “Examples”Invalid
Section titled “Invalid” <video />code-block.jsx:1:2 lint/a11y/useMediaCaption ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
✖ Provide a track for captions when using audio or video elements.
> 1 │ <video />
│ ^^^^^^^^^
2 │
ℹ Captions support users with hearing-impairments. They should be a transcription or translation of the dialogue, sound effects, musical cues, and other relevant audio information.
<audio>child</audio>code-block.jsx:1:2 lint/a11y/useMediaCaption ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
✖ Provide a track for captions when using audio or video elements.
> 1 │ <audio>child</audio>
│ ^^^^^^^^^^^^^^^^^^^^
2 │
ℹ Captions support users with hearing-impairments. They should be a transcription or translation of the dialogue, sound effects, musical cues, and other relevant audio information.
<audio> <track kind="captions" {...props} /> </audio> <video muted {...props}></video>Related links
Section titled “Related links”Copyright (c) 2023-present Biome Developers and Contributors.