snapsvg

JavaScript Vector Library

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
snapsvg
13,5242670.5.16 years ago9 years agoMinified + gzip package size for snapsvg in KB

Readme

Snap.svg · Build Status CDNJS GitHub Tag License ======
A JavaScript SVG library for the modern web. Learn more at snapsvg.io.
Follow us on Twitter.

Install

  • Bower - bower install snap.svg Bower
  • npm - npm install snapsvg npm version Downloads
  • Manual Minified - https://github.com/adobe-webplatform/Snap.svg/raw/master/dist/snap.svg-min.js
  • Manual Unminified - https://raw.githubusercontent.com/adobe-webplatform/Snap.svg/master/dist/snap.svg.js

Learn

Use

In your HTML file, load simply by:
<script src="snap.svg-min.js"></script>
No other scripts are needed. Both the minified and uncompressed (for development) versions are in the /dist folder.
To load with webpack use following command:
const Snap = require(`imports-loader?this=>window,fix=>module.exports=0!snapsvg/dist/snap.svg.js`);

Build

Build Status
Snap.svg uses Grunt to build.
  • Open the terminal from the Snap.svg directory:
cd Snap.svg
  • Install its command line interface (CLI) globally:
npm install -g grunt-cli
You might need to use sudo npm, depending on your configuration.
  • Install dependencies with npm:
npm install
Snap.svg uses Grunt 0.4.0. You might want to read
more on their website if you haven’t upgraded since a lot has changed.
  • To build the files run
grunt
  • The results will be built into the dist folder.
  • Alternatively type grunt watch to have the build run automatically when you make changes to source files.

Testing

Tests are located in test folder. To run tests, simply open test.html in there. Automatic tests use PhantomJS to scrap this file, so you can use it as a reference.
Alternatively, install PhantomJS
and run command
grunt test

Contribute

git checkout -b my_branch
  • Add your changes.
  • Check that tests are passing
  • Commit your changes:
git commit -am "Added some awesome stuff"
  • Push your branch:
git push origin my_branch

Note: Pull requests to other branches than dev or without filled CLA wouldn’t be accepted.