svg-element-dictionary v0.0.0

SVG Element Dictionary

Dictionary of SVG elements.

Dictionary built from the SVG 1.1 specification.

Notes

This is currently a work-in-progress. For many elements the information is incomplete. Use with caution.

Installation

$ npm install svg-element-dictionary --save

Usage

The module is simply a JSON object, so use as you would a normal JavaScript object.

var dict = require( 'svg-element-dictionary' );

console.log( JSON.stringify( dict ) );
/**
* Returns:
*	{
		"a": {
			"desc": "...",
			"url": "...",
			"type": [...],
			"attributes": [...]
		},
		...
	}
*/

console.log( dict[ 'a' ].type );
// Returns [...]

Examples

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ open reports/coverage/lcov-report/index.html

License

MIT license.

Copyright

Copyright © 2014. Athan Reines.