Skip to content

Options and firebug inspector box #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Options and firebug inspector box #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e7c42ab
Added border, realtime, and label as options.
Apr 5, 2013
257e011
Update README.md
Apr 5, 2013
4851872
#2 - Added border, realtime, and label as options.
Apr 5, 2013
c273d27
#2 Adjusted source to 4 space indentation
Jun 18, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,21 @@ myDomOutline.stop();
<td>The private namespace used for CSS selectors and events. Available in the unlikely event of possible event/CSS collisions.</td>
<td>'DomOutline'</td>
</tr>
<tr>
<td><b>border</b></td>
<td>A border used as the visual indicator surrounding the element. If false a semi-transparent blue overlay box is used instead (like firebug).</td>
<td>false</td>
</tr>
<tr>
<td><b>realtime</b></td>
<td>Shows the visual indicator as you hover the mouse over the elements. If false the visual indicator shows when clicking an element (maybe implementing ctrl-left click is better?).</td>
<td>false</td>
</tr>
<tr>
<td><b>label</b></td>
<td>Shows a label above the visual indicator. The label contains the element's name, id, class name, and dimensions.</td>
<td>false</td>
</tr>
</table>

### Other Notes
Expand Down
141 changes: 92 additions & 49 deletions jquery.dom-outline-1.0.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/*global document:false*/
/*global window:false*/
/*global jQuery:false*/
/*global setTimeout:false*/

/**
* Firebug/Web Inspector Outline Implementation using jQuery
* Tested to work in Chrome, FF, Safari. Buggy in IE ;(
Expand All @@ -12,24 +17,29 @@
* myDomOutline.stop();
*/
var DomOutline = function (options) {
'use strict';

options = options || {};

var pub = {};
var self = {
opts: {
namespace: options.namespace || 'DomOutline',
borderWidth: options.borderWidth || 2,
onClick: options.onClick || false
},
keyCodes: {
BACKSPACE: 8,
ESC: 27,
DELETE: 46
},
active: false,
initialized: false,
elements: {}
};
var pub = {},
self = {
opts: {
namespace: options.namespace || 'DomOutline',
borderWidth: options.borderWidth || 2,
onClick: options.onClick || false,
border: options.border || false,
realtime: options.realtime || false,
label: options.label || false
},
keyCodes: {
BACKSPACE: 8,
ESC: 27,
DELETE: 46
},
active: false,
initialized: false,
elements: {}
};

function writeStylesheet(css) {
var element = document.createElement('style');
Expand All @@ -44,12 +54,15 @@ var DomOutline = function (options) {
}

function initStylesheet() {
var css = '';

if (self.initialized !== true) {
var css = '' +
css +=
'.' + self.opts.namespace + ' {' +
' background: #09c;' +
' background: rgba(0, 153, 204, 0.5);' +
' position: absolute;' +
' z-index: 1000000;' +
' pointer-events: none;' +
'}' +
'.' + self.opts.namespace + '_label {' +
' background: #09c;' +
Expand All @@ -60,6 +73,13 @@ var DomOutline = function (options) {
' position: absolute;' +
' text-shadow: 0 1px 1px rgba(0, 0, 0, 0.25);' +
' z-index: 1000001;' +
' pointer-events: none;' +
'}' +
'.' + self.opts.namespace + '_box {' +
' background: rgba(0, 153, 204, 0.5);' +
' position: absolute;' +
' z-index: 1000000;' +
' pointer-events: none;' +
'}';

writeStylesheet(css);
Expand All @@ -68,15 +88,17 @@ var DomOutline = function (options) {
}

function createOutlineElements() {
self.elements.label = jQuery('<div></div>').addClass(self.opts.namespace + '_label').appendTo('body');
self.elements.top = jQuery('<div></div>').addClass(self.opts.namespace).appendTo('body');
self.elements.bottom = jQuery('<div></div>').addClass(self.opts.namespace).appendTo('body');
self.elements.left = jQuery('<div></div>').addClass(self.opts.namespace).appendTo('body');
self.elements.right = jQuery('<div></div>').addClass(self.opts.namespace).appendTo('body');
self.elements.label = jQuery('<div>').addClass(self.opts.namespace + '_label').appendTo('body');
self.elements.top = jQuery('<div>').addClass(self.opts.namespace).appendTo('body');
self.elements.bottom = jQuery('<div>').addClass(self.opts.namespace).appendTo('body');
self.elements.left = jQuery('<div>').addClass(self.opts.namespace).appendTo('body');
self.elements.right = jQuery('<div>').addClass(self.opts.namespace).appendTo('body');

self.elements.box = jQuery('<div>').addClass(self.opts.namespace + '_box').appendTo('body');
}

function removeOutlineElements() {
jQuery.each(self.elements, function(name, element) {
jQuery.each(self.elements, function (name, element) {
element.remove();
});
}
Expand All @@ -99,40 +121,57 @@ var DomOutline = function (options) {
return self.elements.window.scrollTop();
}

function updateOutlinePosition(e) {
if (e.target.className.indexOf(self.opts.namespace) !== -1) {
return;
function stopOnEscape(e) {
if (e.keyCode === self.keyCodes.ESC || e.keyCode === self.keyCodes.BACKSPACE || e.keyCode === self.keyCodes.DELETE) {
pub.stop();
}
pub.element = e.target;

var b = self.opts.borderWidth;
var scroll_top = getScrollTop();
var pos = pub.element.getBoundingClientRect();
var top = pos.top + scroll_top;
return false;
}

var label_text = compileLabelText(pub.element, pos.width, pos.height);
var label_top = Math.max(0, top - 20 - b, scroll_top);
var label_left = Math.max(0, pos.left - b);
function draw(e) {
if (e.target.className.indexOf(self.opts.namespace) !== -1) {
return;
}

self.elements.label.css({ top: label_top, left: label_left }).text(label_text);
self.elements.top.css({ top: Math.max(0, top - b), left: pos.left - b, width: pos.width + b, height: b });
self.elements.bottom.css({ top: top + pos.height, left: pos.left - b, width: pos.width + b, height: b });
self.elements.left.css({ top: top - b, left: Math.max(0, pos.left - b), width: b, height: pos.height + b });
self.elements.right.css({ top: top - b, left: pos.left + pos.width, width: b, height: pos.height + (b * 2) });
}
pub.element = e.target;

function stopOnEscape(e) {
if (e.keyCode === self.keyCodes.ESC || e.keyCode === self.keyCodes.BACKSPACE || e.keyCode === self.keyCodes.DELETE) {
pub.stop();
var b = self.opts.borderWidth,
scroll_top = getScrollTop(),
pos = pub.element.getBoundingClientRect(),
top = pos.top + scroll_top,
label_text = '',
label_top = 0,
label_left = 0;

if (self.opts.label) {
label_text = compileLabelText(pub.element, pos.width, pos.height);
label_top = Math.max(0, top - 20 - b, scroll_top);
label_left = Math.max(0, pos.left - b);
self.elements.label.css({ top: label_top, left: label_left }).text(label_text);
}

return false;
if (self.opts.border) {
self.elements.top.css({ top: Math.max(0, top - b), left: pos.left - b, width: pos.width + b, height: b });
self.elements.bottom.css({ top: top + pos.height, left: pos.left - b, width: pos.width + b, height: b });
self.elements.left.css({ top: top - b, left: Math.max(0, pos.left - b), width: b, height: pos.height + b });
self.elements.right.css({ top: top - b, left: pos.left + pos.width, width: b, height: pos.height + (b * 2) });
} else {
self.elements.box.css({
top: pos.top,
left: pos.left,
width: pos.width,
height: pos.height
});
}
}

function clickHandler(e) {
pub.stop();
self.opts.onClick(pub.element);
if (!self.opts.realtime) {
draw(e);
}

self.opts.onClick(pub.element);
return false;
}

Expand All @@ -141,13 +180,17 @@ var DomOutline = function (options) {
if (self.active !== true) {
self.active = true;
createOutlineElements();
jQuery('body').bind('mousemove.' + self.opts.namespace, updateOutlinePosition);

jQuery('body').bind('keyup.' + self.opts.namespace, stopOnEscape);
if (self.opts.onClick) {
setTimeout(function () {
jQuery('body').bind('click.' + self.opts.namespace, clickHandler);
}, 50);
}

if (self.opts.realtime) {
jQuery('body').bind('mousemove.' + self.opts.namespace, draw);
}
}
};

Expand All @@ -160,4 +203,4 @@ var DomOutline = function (options) {
};

return pub;
};
};
Loading