# svg-element-dictionary

> Dictionary of SVG elements.

Latest version **0.0.0** (published 2014-09-04) · 0 weekly downloads

## Install

```sh
npm install svg-element-dictionary
pnpm add svg-element-dictionary
yarn add svg-element-dictionary
bun add svg-element-dictionary
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2014-09-04 |
| First published | 2014-09-04 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Athan Reines |
| Maintainers | kgryte |
| Keywords | html, svg, tags, elements, w3c |

## Links

- npm: https://www.npmjs.com/package/svg-element-dictionary
- Repository: https://github.com/element-io/svg-element-dictionary
- Issues: https://github.com/element-io/svg-element-dictionary/issues
- npm.io page: https://npm.io/package/svg-element-dictionary

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 0.0.0 (latest) — 2014-09-04

## README

SVG Element Dictionary
=======================
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage][coveralls-image]][coveralls-url] [![Dependencies][dependencies-image]][dependencies-url]

> Dictionary of SVG elements.

Dictionary built from the [SVG 1.1 specification](http://www.w3.org/TR/SVG/eltindex.html).


## Notes

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


## Installation

``` bash
$ npm install svg-element-dictionary --save
```


## Usage

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

``` javascript
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,

``` bash
$ node ./examples/index.js
```


## Tests

### Unit

Unit tests use the [Mocha](http://visionmedia.github.io/mocha) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:

``` bash
$ make test
```

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


### Test Coverage

This repository uses [Istanbul](https://github.com/gotwarlost/istanbul) as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

``` bash
$ make test-cov
```

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

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


## License

[MIT license](http://opensource.org/licenses/MIT). 


---
## Copyright

Copyright &copy; 2014. Athan Reines.



[npm-image]: http://img.shields.io/npm/v/svg-element-dictionary.svg
[npm-url]: https://npmjs.org/package/svg-element-dictionary

[travis-image]: http://img.shields.io/travis/element-io/svg-element-dictionary/master.svg
[travis-url]: https://travis-ci.org/element-io/svg-element-dictionary

[coveralls-image]: https://img.shields.io/coveralls/element-io/svg-element-dictionary/master.svg
[coveralls-url]: https://coveralls.io/r/element-io/svg-element-dictionary?branch=master

[dependencies-image]: http://img.shields.io/david/element-io/svg-element-dictionary.svg
[dependencies-url]: https://david-dm.org/element-io/svg-element-dictionary

[dev-dependencies-image]: http://img.shields.io/david/dev/element-io/svg-element-dictionary.svg
[dev-dependencies-url]: https://david-dm.org/dev/element-io/svg-element-dictionary

[github-issues-image]: http://img.shields.io/github/issues/element-io/svg-element-dictionary.svg
[github-issues-url]: https://github.com/element-io/svg-element-dictionary/issues

---
_Source: https://npm.io/package/svg-element-dictionary · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
