Repository files navigation

A JavaScript SVG library for the modern web. Learn more atsnapsvg.io.

Follow us on Twitter.

• Bower -bower install snap.svg
• npm -npm install snapsvg
• 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

• About Snap.svg
• Getting Started
• API Reference
• Slack Room.Invite

In your HTML file, load simply by:

<scriptsrc="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 2.x and 3.x, installImports Loader (npm i -D imports-loader), and add the following to your webpack config:

module:{rules:[{test:require.resolve('snapsvg/dist/snap.svg.js'),use:'imports-loader?this=>window,fix=>module.exports=0',},],},resolve:{alias:{snapsvg:'snapsvg/dist/snap.svg.js',},},

Then, in any module you’d like to require Snap, use:

import Snap from 'snapsvg';

Snap.svg usesGrunt 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 usesudo npm, depending on your configuration.

• Install dependencies with npm:

npm install

*Snap.svg uses Grunt 0.4.0. You might want toread 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 thedist folder.
• Alternatively typegrunt watch to have the build run automatically when you make changes to source files.

Tests are located intest folder. To run tests, simply opentest.html in there. Automatic tests use PhantomJS to scrap this file, so you can use it as a reference.

Alternatively, installPhantomJS and run command

grunttest

• Fill out the CLA.
• Fork the repo.
• Create a branch:

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

• Make apull request todev(!) branch.

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