raphael README

The project's README from github.com/DmitryBaranovskiy/raphael. As one markdown file: README.md.

Raphaël: Cross-browser vector graphics the easy way

Visit the library website for more information: http://raphaeljs.com https://dmitrybaranovskiy.github.io/raphael/

Quickstart guide

You need to have NPM installed to build the library.

To run tests you need to run npx bower install open dev/test/index.html in your browser, there's no automated way right now.

Dependencies

Distributable

All files are UMD compliant.

You can use:

Where to start

Check Raphael-boilerplate to see examples of loading.

Raphael can be loaded in a script tag or with AMD:

define([ "path/to/raphael" ], function( Raphael ) {
  console.log( Raphael );
});

Development

Versions will be released as we gather and test new PRs. As there are a lot of browsers being supported it might take a while to accept a PR, we will use the feedback from other users too.

You can use the raphaelTest.html to try things, you need to start a server in the root dir to start testing things there. Something like running python -m SimpleHTTPServer in the raphael directory and hitting http://localhost:8000/dev/raphaelTest.html with the browser. You should run npm run start before this can work.

Collaborators

Books

Copyright © 2008-2013 Dmitry Baranovskiy (http://dmitrybaranovskiy.github.io/raphael/)

Copyright © 2008-2013 Sencha Labs (http://sencha.com)

Licensed under the MIT (http://dmitrybaranovskiy.github.io/raphael/license.html) license.

raphael (DmitryBaranovskiy/raphael)

vector-graphics
Searching Database…

11.3K ·GitHub
What is this?Raphaël is a JavaScript vector-graphics library for the browser: you draw shapes, text and animations through its API, and it renders across different browsers.
Is this a library I code against, or a standalone app?A library, not an app — you add it to your own web page and draw through its JavaScript API; there is nothing to install or run on its own.
How do I get it into my project?Load a distributable such as raphael.min.js with a script tag or AMD — Raphael-boilerplate shows loading examples. Building from source needs NPM: git clone, yarn install --frozen-lockfile, yarn build-all.
Does it need any other libraries to work?Only one: eve. The standard builds bundle it, while raphael.no-deps.js and raphael.no-deps.min.js ship without it, so you can load eve separately if you prefer.
Any gotchas I should know before picking it?Testing is manual — you open dev/test/index.html in a browser; there is no automated test run. And with so many browsers supported, pull requests can take a while to be accepted.
Is it free to use, including commercial projects?Yes — Raphaël is MIT licensed (copyright Dmitry Baranovskiy and Sencha Labs), so it is free for any use, including commercial.
Is the project still actively developed?There is no fixed release schedule — new versions come out as the maintainers gather and test community pull requests, with feedback from other users helping decide what lands.
Where can I see examples or learn it properly?The README points to Raphael-boilerplate for loading examples and to a raphaelTest.html playground you can run locally with any static server. There are also books: Learning Raphael JS Vector Graphics and Instant RaphaelJS Starter.
What other projects are built around Raphaël?The README lists six related projects: graphael, raphael.boilerplate, backbone.raphael, mapael, snap and react-raphael — including integrations with Backbone and React.
What are similar projects?mojs, vivus, paper.js, svg.js, lottie-web, anime, fabric.js, zdog
Size
6.7 MB
Stars
11.3K
Age
18y
Commits · 90 Days