# jsdom 0.2.1 A javascript implementation of the W3C DOM. ## Install npm install jsdom or git clone http://github.com/tmpvar/jsdom.git cd jsdom npm link ## Easymode Bootstrapping a DOM is generally a difficult process involving many error prone steps. We didn't want jsdom to fall into the same trap and that is why a new method, `jsdom.env()`, has been added in jsdom 0.2.0 which should make everyone's lives easier. with URL // Count all of the links from the nodejs build page var jsdom = require("jsdom"); jsdom.env("http://nodejs.org/dist/", [ 'http://code.jquery.com/jquery-1.5.min.js' ], function(errors, window) { console.log("there have been", window.$("a").length, "nodejs releases!"); }); or with raw html // Run some jQuery on a html fragment var jsdom = require('jsdom'); jsdom.env('

', jsdom.dom.level1.core) - `options` see the **Flexibility** section below ### Flexibility One of the goals of jsdom is to be as minimal and light as possible. This section details how someone can change the behavior of `Document`s on the fly. These features are baked into the `DOMImplementation` that every `Document` has, and may be tweaked in two ways: 1. When you create a new `Document` using the jsdom builder (`require('jsdom').jsdom()`) var jsdom = require('jsdom').jsdom, doc = jsdom("", 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) 2. 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 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. `FetchExternalResources` _Default_: ['script'] _Allowed_: ['script', 'img', 'css', 'frame', 'link'] or false Enables/Disables fetching files over the filesystem/http `ProcessExternalResources` _default_: ['script'] _allowed_: ['script'] or false Disabling this will disable script execution (currently only javascript). `MutationEvents` _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. **Note**: `ProcessExternalResources` requires this to be enabled `QuerySelector` _default_ : false _allowed_ : true This feature is backed by [sizzle][] but currently causes problems with some libraries. Enable this 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. [sizzle]:http://sizzlejs.com/ # More Examples ## Creating a document-less window var jsdom = require("jsdom"), window = jsdom.createWindow(); console.log(window.document); // output: undefined ## Creating a document var jsdom = require("jsdom"), doc = new (jsdom.dom.level1.core.Document)(); console.log(doc.nodeName); // outputs: #document ## Creating a browser-like BOM/DOM/Window var jsdom = require("./lib/jsdom").jsdom, document = jsdom("hello world"), window = document.createWindow(); console.log(window.document.innerHTML); // output: 'hello world' console.log(window.innerWidth) // output: 1024 console.log(typeof window.document.getElementsByClassName); // outputs: function ## jQueryify 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('

'); console.log(window.$('.testing').text()); }); # Test Compliance: level1/core 529/529 100% level1/html 238/238 100% level1/svg 527/527 100% level2/core 283/283 100% level2/html 687/687 100% level2/style 3/3 100% level2/extra 4/4 100% level3/xpath 93/93 100% window 2/2 100% sizzle/index 12/15 80% jsdom/index 44/44 100% ------------------------------------- TOTALS: 3/2425 failed; 99% success TIME: 9373ms ## Running the tests First you'll want to `npm install -g nodeunit` then `npm install --dev` Using `test/runner` you can slice and dice which tests your want to run from different levels. Usage is as follows: test/runner --help Run the jsdom test suite Options: -s, --suites suites that you want to run. ie: -s level1/core,1/html,html [string] -f, --fail-fast stop on the first failed test -h, --help show the help -t, --tests choose the test cases to run. ie: -t jquery # More see: [mailing list][] see: [project site][] for additional information [mailing list]: http://groups.google.com/group/jsdom [project site]: http://www.jsdom.org