<p>The Widgetkit Spotlight allows you to add an overlay to your images, which fades or moves in on mouse hover. The overlay can be an image or HTML content. The default magnifier spotlight is a perfect match for the Widgetkit lightbox.</p>

<h2>Features</h2>

<ul class="uk-list uk-list-space">
  <li><i class="uk-icon uk-icon-check"></i> Create nicely animated image overlays</li>
  <li><i class="uk-icon uk-icon-check"></i> Supports custom image or HTML content overlays</li>
  <li><i class="uk-icon uk-icon-check"></i> 5 different animation modes</li>
  <li><i class="uk-icon uk-icon-check"></i> Responsive design to fit all device resolutions</li>
  <li><i class="uk-icon uk-icon-check"></i> Built with the latest jQuery version</li>
  <li><i class="uk-icon uk-icon-check"></i> Works with Joomla and WordPress</li>
</ul>

<h2>Examples</h2>

<p>If no custom overlay is set, the default spotlight fades in an overlay with a magnifier image. If you define a custom overlay, you can choose between different animations - <code>fade</code>, <code>bottom</code>, <code>top</code>, <code>right</code> and <code>left</code>.</p>

<div>
  <a data-spotlight="on" data-lightbox="transitionIn:elastic;transitionOut:elastic;" href="images/yootheme/widgetkit/lightbox/image1_lightbox.jpg">
    <img src="images/yootheme/widgetkit/lightbox/image1.jpg" width="180" height="120" alt="Spotlight Image" />
  </a>
  <a data-spotlight="effect:bottom;" data-lightbox="transitionIn:elastic;transitionOut:elastic;" href="images/yootheme/widgetkit/lightbox/image2_lightbox.jpg">
    <img src="images/yootheme/widgetkit/lightbox/image2.jpg" width="180" height="120" alt="Spotlight Image" />
    <div class="overlay">Custom Overlay (Bottom)</div>
  </a>
  <a data-spotlight="effect:right;" data-lightbox="transitionIn:elastic;transitionOut:elastic;" href="images/yootheme/widgetkit/lightbox/image3_lightbox.jpg">
    <img src="images/yootheme/widgetkit/lightbox/image3.jpg" width="180" height="120" alt="Spotlight Image" />
    <div class="overlay">Custom Overlay (Right)</div>
  </a>
</div>

<div>
  <a data-spotlight="effect:fade;" data-lightbox="transitionIn:elastic;transitionOut:elastic;" href="images/yootheme/widgetkit/lightbox/image4_lightbox.jpg">
    <img src="images/yootheme/widgetkit/lightbox/image4.jpg" width="180" height="120" alt="Spotlight Image" />
    <div class="overlay remove-padding"><img src="images/yootheme/widgetkit/lightbox/image4_spotlight.jpg" width="180" height="120" alt="Spotlight Image" /></div>
  </a>
  <a data-spotlight="effect:top;" data-lightbox="transitionIn:elastic;transitionOut:elastic;" href="images/yootheme/widgetkit/lightbox/image5_lightbox.jpg">
    <img src="images/yootheme/widgetkit/lightbox/image5.jpg" width="180" height="120" alt="Spotlight Image" />
    <div class="overlay">Custom Overlay (Top)</div>
  </a>
  <a data-spotlight="effect:left;" data-lightbox="transitionIn:elastic;transitionOut:elastic;" href="images/yootheme/widgetkit/lightbox/image6_lightbox.jpg">
    <img src="images/yootheme/widgetkit/lightbox/image6.jpg" width="180" height="120" alt="Spotlight Image" />
    <div class="overlay">Custom Overlay (Left)</div>
  </a>
</div>

<h2>How To Use</h2>

<p>Use the HTML5 custom data attribute <code>data-spotlight</code> to activate the spotlight.

<pre>&lt;a data-spotlight="on" href="/mypage.html"&gt;
  &lt;img src="/image.jpg" width="180" height="120" alt="" /&gt;
&lt;/a&gt;</pre>

<p>To create a custom overlay, use a div element with the CSS class <code>overlay</code>. You can set the effect parameter to the data attribute. For example:</p>

<pre>&lt;a data-spotlight="effect:bottom;" href="/mypage.html"&gt;
  &lt;img src="/image.jpg" width="180" height="120" alt="" /&gt;
  &lt;div class="overlay"&gt;Custom Overlay&lt;/div&gt;
&lt;/a></pre>

<p>You can set the effect parameter to <code>fade</code>, <code>bottom</code>, <code>top</code>, <code>right</code> and <code>left</code>.