focusable-element

Focusable  
=============

An awesome and lightweight library for performing spotlight in your DOM elements, setting an animated overlay to the rest of the page.
You can find a live demo here.

$3




$3

###### Set spotlight (jQuery style)
``javascript
$('#my-element').setFocus(options);
`
###### Set spotlight (through library)
`javascript
Focusable.setFocus($('#my-element'), options);
`
###### Refresh current focused element
`javascript
Focusable.refresh();
`
###### Hide spotlight
`javascript
Focusable.hide();
`
###### Get focused element
`javascript
Focusable.getActiveElement();
`
###### Get options
`javascript
Focusable.getOptions();
`

###### Options
Property | Value | Default | Description
------------ | ------------- | ------------- | -------------
fadeDuration | Number | 700 | Duration of the overlay transition (milliseconds).
hideOnClick | Boolean | false | Hides the overlay when the user click into it.
hideOnESC | Boolean | false | Hides the overlay when the user press Esc.
findOnResize | Boolean | false | Refind the element in the DOM in case that the element don't still exists.
circle | Boolean | false | Have the spotlight in a circle shape

###### Runing tests
* npm install
* grunt
* See the result of testsuite in http://localhost:9092

###### Dependencies
- jQuery

###### Contributing

0. Check open issues
1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature`)
5. Create a new Pull Request

###### Author
You can follow me on Twitter - https://twitter.com/zzarcon