hs.captionEval
An expression to be evaluated into the
caption text.
By using captionEval you gain direct access into the hs.Expander context, which means you can define the caption to be pulled from the alt attribute of the thumbnail, the title of the thumbnail or whatever property you want. You can also combine these.
A great advantage of using the thumbnail's alt attribute for caption text, is that this is indexed by the search engines and associated with the image.
Examples of using attributes from the thumbnail or opening anchor are:
- this.thumb.alt
- The
alt
attribute of the thumbnail img
.
- this.thumb.title
- The
title
attribute of the thumbnail img
.
- this.a.title
- The
title
attribute of the opening anchor.
Details
Requires |
overlays |
Type |
string |
Default value |
null |
Overrideable inline |
Yes |
Example
Pulling the caption from the thumbnail's alt attribute
Put this in the head section of your page. This affects all expanders on your page.
<script type="text/javascript">
hs.captionEval = 'this.thumb.alt';
</script>
Apply a meaningful alt attribute to your thumbnail image.
<a class="highslide" href="../samples/full3.jpg"
onclick="return hs.expand(this)">
<img src="../samples/thumb3.jpg"
alt="This is the alt attribute for the image"/>
</a>
The effect:
See also