CANE

A modular (CommonJS based) JavaScript DOM library.

What

A completely modular collection of dom and ajax based utils for the browser, written in node-style commonJS. This allows minifiers to pull only necessery code while giving the developer a variety of handy tools.

Docs

Browser the different packages in the docs folder

• dom: Helpers for various DOM manipulation.
• events: Helpers for DOM event related business.
• net: Helpers for all sorts of AJAX requests.
• style: CSS and style related shenanigans.
• utils: Mostly internal tools, that might just be handy elsewhere.

Goals

• Modularity
• No global namespace
• No wrapper object
• Independent modules
• Well tested modules
• Play well with other libraries

Development

Cane uses Grunt to manage the development tasks. Tests are ran by the Karma test runner. To install all the development dependencies run npm install.

To run the tests once, simply run npm test in the root of the repository. You must have Chrome and Firefox installed. It will run JSHint on all the files and then launch Chrome and Firefox and run all the tests.

The documentation is generated from the Markdown files in the docs directory. To generate the docs run grunt docs. The docs are also automatically generated when you are running grunt (or npm start) and a file in the docs directory changes. The generated HTML files are stored in the docs_html directory.

License

Released under the MIT License

Authors

• @conradz
• @MathiasPaumgarten