Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
Allow or force editors to provide alt text for Image content items #2837
When creating or editing an Image content item, there should be a (new) field for entering alt text. The contents of this field should be put into the alt attribute of the image when it is viewed by itself (as an image object). The image's markup should never include a title attribute. This is considered redundant to the alt text which is the proper way to convey the image's meaning to those using screen readers. Note that when displaying the image object the Title and Description will show and will be read by screen readers; the alt text should be a non-redundant description of the image itself.
If the accessibility control panel (#2834) is set to force editors to enter alt text for images, then the alt text field will be required.
Field name: Alt Text
Help text: Briefly describe the meaning of the image for people using assistive technology like screen readers. This will be used when the image is viewed by itself. Do not duplicate the Title or Description fields, since they will also be read by screen readers. Alt text should describe what a sighted user sees when looking at the image. This might include text the image contains, or even a description of an abstract pattern. This field should never be left blank on sites that want to be compliant with accessibility standards.
This was referenced
Apr 18, 2019
@hvelarde please see #2836 which describes the situations when alt text should be empty. These situations can occur when an image is used within rich text. That is a different piece of alt text, which is filled out by the editor of the rich text when inserting the image, to convey the meaning of the image in context. The situations when alt text should be empty won't occur when an Image object is displayed on its own, thus the alt text in this case should always be present and describe the image.