box-model-inspector
v1.0.1
Published
Devtools style css box model inspector in javascript
Downloads
12
Maintainers
Readme
Box Model Inspector
Devtools style dom node inspector. Highlights the CSS box model just like chrome devtools. Draws a box around a given element highlighting width, height, margin, border & padding.
Demo: http://a-axton.github.io/box-model-inspector/
Caveats
- Expects box-sizing border-box
- Doesn't work well with fixed position elements. It highlights properly but won't stay in the proper position when scrolling.
Installation
npm
npm install box-model-inspector --save
inline
<script type="text/javascript" src="/path/dist/box-model-inspector.js"></script>
Theming
* { box-sizing: border-box; }
/* CONTENT */
.box-model .content {
background: rgba(109, 238, 245, 0.5);
}
/* MARGIN */
.box-model .margin {}
.box-model .marginTop {}
.box-model .marginRight {}
.box-model .marginBottom {}
.box-model .marginLeft {}
.box-model .margin div {
background: rgba(251, 176, 91, 0.65);
}
/* PADDING */
.box-model .padding {}
.box-model .paddingTop {}
.box-model .paddingRight {}
.box-model .paddingBottom {}
.box-model .paddingLeft {}
.box-model .padding div {
background: rgba(139, 234, 127, 0.65);
}
/* BORDER */
.box-model .border {}
.box-model .borderTop {}
.box-model .borderRight {}
.box-model .borderBottom {}
.box-model .borderLeft {}
.box-model .border div {
background-color: rgba(234, 228, 105, .8);
}
Sample Usage
var BoxModelInspector = require('box-model-inspector');
// all options are optional
var boxModelInspector = new BoxModelInspector({
// initial element to highlight
el: document.querySelectorAll('.example')[0],
// custom class, defaults to 'box-model'
className: 'box-model',
// will append to element, uses body as default
appendTo: document.body
});
// set new element to be highlighted
document.body.addEventListener('mousemove', function(e) {
boxModelInspector.setElement(e.target);
e.stopPropagation();
});
// refresh dimensions
window.addEventListener('resize', function() {
boxModelInspector.refresh();
});
Methods
setElement
Set new element to highlight
Example
var el = document.getElementById('el');
boxModelInspector.setElement(el);
refresh
Refresh current element's box model
Example
window.addEventListener('resize', function() {
boxModelInspector.refresh();
});
hide
Hide it
Example
boxModelInspector.hide();
show
Show it
Example
boxModelInspector.show();