#Dim The Lights
Dim The Lights (DTL) is a jQuery plugin which allows you to darken the area around any element.
##Usage
Include the CSS and Javascript files in the <head>
<head>
<link href="jquery.dimlights.min.css" type="text/css" rel="stylesheet" />
<script type="text/javascript" src="http://code.jquery.com/jquery.min.js"></script>
<script src="jquery.dimlights.min.js" type="text/javascript"></script>
</head>
Call DTL anywhere using $.dimTheLights()
$("#some_elem").click(function() {
$.dimTheLights();
});
##Settings
opacity - How much to darken by. Accepts 0-1 and defaults to 0.75.
background - The background to apply to the element after. Accepts any hex colour code such as #FA7BA7.
classes - Any additional classes to apply to the element. Accepts an array of strings such as ['rounded', 'shadow', 'red_border'].
softBg - Adds blur and roundness to the background to achieve a softer feel. Accepts true/flase and defaults to false.
closeOnClick - Closes DimTheLights when the clone is clicked. Accepts true/false and defaults to false.
hideTarget - Specifies wether or not to hide the target element. Accepts true/false and defaults to true.
##Issues & Bugs
Report any issues or bugs using one of the following:
- Github's issue tracker
- Twitter: @JordanCallumA
- Email: jordan_callum@live.co.uk