CommonJS implementation of the DOM intended to be platform independent and as minimal/light as possible while completely adhering to the w3c DOM specifications.
Currently Implemented and w3c Compliant:
- DOM Level 1 (html/svg/xml)
- DOM Level 2 (html/events) with partial level2/core support
- Browser (BOM) Augmentation (getElementsByClassName, getElementById, etc..)
Note: Running the tests now requires mjsunit.runner
see: mailing list
see: testlog for w3/jsdom test compliance
see: plan for roadmap and thoughts about this project
see: project site for additional information
One of the stated goals of jsdom is to be as minimal and light as possible. This section details how
someone can change the behavior of Documents on the fly. These features are baked into
the DOMImplementation that every Document has. These features can be tweaked in two ways:
-
When you create a new
Documentusing the jsdom builder (require('jsdom').jsdom())var jsdom = require('jsdom').jsdom, doc = jsdom("<html><body></body></html>", null, { features: { FetchExternalResources : ['img'] } });
Do note, that this will only affect the document that is currently being created. All other documents will use the defaults specified below (see: Default Features)
-
Previous to creating any documents you can modify the defaults for all future documents
require('jsdom').defaultDocumentFeatures = { FetchExternalResources : ['script'], ProcessExternalResources : false, MutationEvents : false, QuerySelector : false }
Default features are extremely important for jsdom as they lower the configuration requirement and present developers a set of consistent default behaviors. The following sections detail the available features, their defaults, and the values that jsdom uses.
Default: ['script']
Allowed: ['script', 'img', 'css', 'frame', 'link'] or false
Enables/Disables fetching files over the filesystem/http
Default ['script']
Allowed ['script'] or false
By default, jsdom executes text content in a SCRIPT and the text retrieved from fetching data from a SCRIPT.src. Turning it off will disable script execution (currently only javascript)
Support for frames is in the works
Default : '2.0'
Allowed : '2.0' or false
Initially enabled to be up to spec. Disable this if you do not need mutation events and want jsdom to be a bit more efficient.
Default : false
Allowed : true
This feature is backed by [sizzle][]
[sizzle]: http://sizzlejs.com/ but currently causes problems with some libraries. Enable if you want document.querySelector and friends, but be aware that many libraries feature detect for this, and it may cause you a bit of trouble.
var jsdom = require("jsdom"),
window = jsdom.createWindow();
console.log(window.document);
// output: undefined
var jsdom = require("jsdom"),
doc = new (jsdom.dom.level1.core.Document)();
console.log(doc.nodeName);
// outputs: #document
var jsdom = require("./lib/jsdom").jsdom,
document = jsdom("<html><head></head><body>hello world</body></html>"),
window = document.createWindow();
console.log(window.document.innerHTML);
// output: '<html><head></head><body>hello world</body></html>'
console.log(window.innerWidth)
// output: 1024
console.log(typeof window.document.getElementsByClassName);
// outputs: function
var document = require("jsdom").jsdom(),
window = document.createWindow(),
script = document.createElement("script");
script.src = 'http://code.jquery.com/jquery-1.4.2.js';
script.onload = function() {
console.log(window.jQuery.fn.jquery);
// outputs: 1.4.2
};
document.head.appendChild(script);
var jsdom = require("jsdom"),
window = jsdom.jsdom().createWindow();
jsdom.jQueryify(window, 'http://code.jquery.com/jquery-1.4.2.min.js' , function() {
window.$('body').append('<div class="testing">Hello World, It works</div>');
console.log(window.$('.testing').text());
});
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent