You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
<!DOCTYPE html><html><head><scriptsrc="../path/to/highlighter.min.js"></script></head><body>//your body here...//If you prefer performances, you can load the script at the bottom of your<body> instead of inside<head></body>
Bower
bower install highlighter.js
npm
npm install highlighter.js
Usage
document.addEventListener("DOMContentLoaded",function(){varHighlighter=newwindow.Highlighter();Highlighter.next('<div>');Highlighter.underline();window.console.log('Highlighter underlined this element:',Highlighter.element);});
If you want a different highlighter color set the option{ color:'#cc0011'}
varHighlighter=newwindow.Highlighter({'color':'blue'//you can use any CSS valid color value});
Exclude hidden/invisible elements
Sometime you could need to work only on visible/viewable elements, so, to skip invisible or hidden elements, set the option{ viewable:true}
varHighlighter=newwindow.Highlighter({'viewable':true//this way Highlighter.js will exclude/avoid selecting or highlighting hidden/invisible elements});
Scroll to the underlined element
Sometime you could need to scroll to the current underlined element, so, to automatically scroll to it once is underlined you can set the options{scroll:true, scrollDuration: 500 }
varHighlighter=newwindow.Highlighter({'scroll':true,//Automatically scroll to the underlined element'scrollDuration':500//milliseconds});
Events
There is a set of events that you could use for your needs.
window.addEventListener('Highlighter:selected',function(evt){console.log('This element has been selected',evt.eventData);});
window.addEventListener('Highlighter:underlined',function(evt){console.log('This element has been underlined',evt.eventData);});
window.addEventListener('Highlighter:erased',function(evt){console.log('This element has been erased',evt.eventData);});
window.addEventListener('Highlighter:skipped',function(){console.log('Elements were skipped');});
window.addEventListener('Highlighter:scrolled',function(evt){console.log('Scrolled to this element',evt.eventData);});
window.addEventListener('Highlighter:restart',function(){console.log('Highlighter restarted from the first DOM element');});
Gtk
Not yet 100% ready for production
If your element/s hasoutline: CSS rule setted up, there could be problems or maybe not.
isVisible() control need a deep check, it could probably mistake at any time
Scroller is a bit horrible atm
If no selectable next elements, Highlighter will restart from the first element in DOM
If no selectable previous elements, Highlighter will restart from the first element in DOM
License
The MIT License (MIT)
Copyright (c) 2015 Filippo Oretti, Dario Andrei
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
