HTMLImageElement: longDesc property
Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see thecompatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
ThedeprecatedlongDesc property of theHTMLImageElement interface specifies the URL of a text or HTML file which contains a long-form description of the image. This can be used to provide optional added details beyond the short description provided in thetitle attribute. It reflects the<img> element'slongdesc content attribute.
This attribute is considered obsolete in theHTML spec. It has an uncertain future; authors should use aWAI-ARIA alternative such asaria-describedby oraria-details. You can also encapsulate the image within a link using the<a> element.
Value
A string which may be either an empty string (indicating that no long description is available) or the URL of a file containing a long form description of the image's contents.
Examples
Consider the following older HTML:
<img src="taco-tuesday.jpg" alt="Taco Tuesday" longdesc="image-descriptions/taco-tuesday.html" />Here, thelongDesc is used to indicate that the user should be able to access a detailed description of the imagetaco-tuesday.jpg in the HTML fileimage-descriptions/taco-tuesday.html.
This should be converted into the following HTML:
<a href="image-descriptions/taco-tuesday.html"> <img src="taco-tuesday.jpg" alt="Taco Tuesday" /></a>With that, the image is a link to the HTML file describing the image in more detail.
Specifications
| Specification |
|---|
| HTML # dom-img-longdesc |