Socket
Socket
Sign inDemoInstall

dom-tools

Package Overview
Dependencies
0
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

dom-tools


Version published
Maintainers
1
Install size
91.8 kB
Created

Readme

Source

dom-tools

A lightweight, tiny collection of DOM Helpers for IE8+. The API attempts to mirror much of jQuery's API. (e.g. DOMUtils.css(el, 'height') -> $(el).css('height'))

This library is just naive wrappers around common DOM API inconsistencies. Cross browser work is minial and mostly taken from jQuery and react-bootstrap/dom-helpers. If you need robust cross-browser support, you should use jQuery instead.

This library does not put a lot of effort to normalize behavior across browsers. Instead it seeks to provide a common interface and help reduce boilerplate code for having to check if (IE8).

For example, DOMTools.addEventListener works in all browsers IE8+. Otherwise you'd be writing:

if (document.addEventListener) {
  element.addEventListener(eventType, handler);
} else if (document.attachEvent) {
  element.attachEvent('on' + eventType, handler);
}

One advantage of this collection is that any method can be required individually. If you use build tools such as Browserify or Webpack, it will only include the exact methods you use. This is great for when environments where jQuery doesn't make sense, or is not a requirement, such as React where you only occasionally need to do direct DOM manipulations.

Installation

Using npm:

npm install dom-tools --save

Using as inline <script> tag

Just include the dom-tools.js or dom-tools.min.js file.

Basic usage

Template:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>DOMTools: Basic usage</title>
  <style>
  #foo {
    height: 50px;
    passing: 5px;
    margin: 5px;
  }
  </style>
</head>
<body>
  <div id="foo" style="margin-right: 5px; border: 1px solid #333;">bar</div>
</body>
</html>

Inline <script> tag

<script src="dom-tools.js"></script>
<script>
  var foo = document.getElementById('foo');
  
  console.log(DOMTools.css(foo, 'width'));
  console.log(DOMTools.css(foo, 'height'));
  console.log(DOMTools.outerWidth(foo, true));
  console.log(DOMTools.outerWidth(foo, false));
  // 1491px
  // 50px
  // 1503
  // 1493
</script>

CommonJS:

var DOMTools = require('dom-tools');

var foo = document.getElementById('foo');

console.log(DOMTools.css(foo, 'width'));
console.log(DOMTools.css(foo, 'height'));
console.log(DOMTools.outerWidth(foo, true));
console.log(DOMTools.outerWidth(foo, false));
// 1491px
// 50px
// 1503
// 1493

API

@todo:

What's next?

  1. Create tests
  2. Complete API documentation
  3. Add additional methods

Keywords

FAQs

Last updated on 15 Feb 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc