What is this?

Highlighter.js is a tiny (pure javascript) library to easily navigate, select and highlight the DOM elements.

Browser Support

Depending on

Installation

HTML

<!DOCTYPE html>
<html>
<head>
<script src="../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() {

  var Highlighter = new window.Highlighter();

  Highlighter.next('<div>');
  Highlighter.underline();

  window.console.log('Highlighter underlined this element:', Highlighter.element);
});

Demo

Live demo

Commands

Select Next

Select next element starting from the current selected element (by default is the first DOM element)

Highlighter.next();

Select Previous

Select previous element starting from the current selected element ( by default is the first DOM element)

Highlighter.previous();

Skip Next

Skip a bunch of next elements starting from the current selected element

Highlighter.skipNext(50);

Skip Previous

Skip a bunch of previous elements starting from the current selected element

Highlighter.skipPrev(35);

Underline

Highlight the current selected element

Highlighter.underline();

Erase

Remove highlighting from the current selected element

Highlighter.erase();

Select Next by ID

Select next element (by ID) starting from the current selected element (by default is the first DOM element)

Highlighter.next('#test');

Select Next by class/es

Select next element (by class/classes) starting from the current selected element (by default is the first DOM element)

Highlighter.next('.class .class-2');

Select Next by < tag > name

Select next element (by < tag > name) starting from the current selected element (by default is the first DOM element)

Highlighter.next('<span>');

Select Previous by ID

Select previous element (by ID) starting from the current selected element (by default is the first DOM element)

Highlighter.previous('#test');

Select Previous by class/es

Select previous element (by class/classes) starting from the current selected element (by default is the first DOM element)

Highlighter.previous('.class .class-2');

Select Previous by < tag > name

Select previous element (by < tag > name) starting from the current selected element (by default is the first DOM element)

Highlighter.previous('<span>');

Select Element By ID

Select first element in the DOM by ID

Highlighter.select('#id');

Select Element by class/es

Select first element in the DOM by class or classes

Highlighter.select('.class .class2');

Select Element by tag name

Select first element in the DOM by < tag > name

Highlighter.select('<span>');

Point Element as starting line

Point the Highlighter to a starting element so that Highlighter will start from that element and not from the first DOM element

var element = window.document.getElementById('startFromThis');
Highlighter.point(element);

Options

Highlighter color

If you want a different highlighter color set the option { color:'#cc0011'}

var Highlighter = new window.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}

var Highlighter = new window.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 }

var Highlighter = new window.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 has outline: 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)

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.