112 lines
3.9 KiB
Markdown
112 lines
3.9 KiB
Markdown
[Snap.svg](http://snapsvg.io) · [](https://travis-ci.org/adobe-webplatform/Snap.svg) [](https://cdnjs.com/libraries/snap.svg/) [](https://github.com/adobe-webplatform/Snap.svg/releases) [](https://github.com/adobe-webplatform/Snap.svg/blob/master/LICENSE)
|
||
======
|
||
|
||
A JavaScript SVG library for the modern web. Learn more at [snapsvg.io](http://snapsvg.io).
|
||
|
||
[Follow us on Twitter.](https://twitter.com/snapsvg)
|
||
|
||
### Install
|
||
* [Bower](http://bower.io/) - `bower install snap.svg` 
|
||
* [npm](http://npmjs.com/) - `npm install snapsvg` [](https://www.npmjs.com/package/snapsvg) [](https://www.npmjs.com/package/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
|
||
|
||
|
||
### Learn
|
||
|
||
* [About Snap.svg](http://snapsvg.io/about/)
|
||
* [Getting Started](http://snapsvg.io/start/)
|
||
* [API Reference](http://snapsvg.io/docs/)
|
||
* [Slack Room](https://snapsvg.slack.com/). [Invite](https://snapsvg.slack.com/shared_invite/MTM2NTE4MTk3MDYwLTE0ODYwODgzNzUtYjQ0YmM1N2U0Mg)
|
||
|
||
### Use
|
||
|
||
In your HTML file, load simply by:
|
||
```html
|
||
<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.
|
||
|
||
#### webpack
|
||
To load with webpack 2.x and 3.x, install [Imports Loader](https://github.com/webpack-contrib/imports-loader) (`npm i -D imports-loader`), and add the following to your webpack config:
|
||
|
||
```js
|
||
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';
|
||
```
|
||
|
||
### Build
|
||
[](https://travis-ci.org/adobe-webplatform/Snap.svg)
|
||
|
||
Snap.svg uses [Grunt](http://gruntjs.com/) to build.
|
||
|
||
* Open the terminal from the Snap.svg directory:
|
||
```sh
|
||
cd Snap.svg
|
||
```
|
||
* Install its command line interface (CLI) globally:
|
||
```sh
|
||
npm install -g grunt-cli
|
||
```
|
||
_*You might need to use `sudo npm`, depending on your configuration._
|
||
|
||
* Install dependencies with npm:
|
||
```sh
|
||
npm install
|
||
```
|
||
_*Snap.svg uses Grunt 0.4.0. You might want to [read](http://gruntjs.com/getting-started) more on their website if you haven’t upgraded since a lot has changed._
|
||
|
||
* To build the files run
|
||
```sh
|
||
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](http://phantomjs.org) and run command
|
||
```sh
|
||
grunt test
|
||
```
|
||
|
||
### Contribute
|
||
|
||
* [Fill out the CLA](http://snapsvg.io/contributions/).
|
||
* [Fork](https://help.github.com/articles/fork-a-repo) the repo.
|
||
* Create a branch:
|
||
```sh
|
||
git checkout -b my_branch
|
||
```
|
||
* Add your changes.
|
||
* Check that tests are passing
|
||
* Commit your changes:
|
||
```sh
|
||
git commit -am "Added some awesome stuff"
|
||
```
|
||
* Push your branch:
|
||
```sh
|
||
git push origin my_branch
|
||
```
|
||
* Make a [pull request](https://help.github.com/articles/using-pull-requests) to `dev`(!) branch.
|
||
|
||
*Note:* Pull requests to other branches than `dev` or without filled CLA wouldn’t be accepted.
|