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)

Searching Database…

11.3K ·GitHub
Что это такое?Raphaël — это JavaScript-библиотека векторной графики для браузера: вы рисуете фигуры, текст и анимации через её API, и она одинаково работает в разных браузерах.
Это библиотека, под которую я пишу код, или отдельное приложение?Это библиотека, а не приложение — вы подключаете её к своей веб-странице и рисуете через её JavaScript API; устанавливать и запускать её отдельно не нужно.
Как добавить её в свой проект?Подключите готовый файл, например raphael.min.js, через тег script или AMD — примеры подключения есть в Raphael-boilerplate. Для сборки из исходников нужен NPM: git clone, yarn install --frozen-lockfile, yarn build-all.
Нужны ли ей для работы другие библиотеки?Только одна: eve. В стандартных сборках она уже встроена, а raphael.no-deps.js и raphael.no-deps.min.js поставляются без неё — так что при желании можно подключить eve отдельно.
Есть ли подводные камни, о которых стоит знать заранее?Тестирование ручное — вы открываете dev/test/index.html в браузере, автоматических тестов нет. А из-за большого числа поддерживаемых браузеров pull request'ы могут приниматься довольно долго.
Можно ли пользоваться бесплатно, в том числе в коммерческих проектах?Да — Raphaël распространяется по лицензии MIT (авторские права Dmitry Baranovskiy и Sencha Labs), поэтому её можно свободно использовать для любых целей, включая коммерческие.
Проект ещё развивается?Фиксированного графика релизов нет — новые версии выходят по мере того, как мейнтейнеры собирают и тестируют pull request'ы от сообщества, а отзывы других пользователей помогают решить, что попадёт в релиз.
Где посмотреть примеры или нормально изучить библиотеку?В README указаны Raphael-boilerplate с примерами подключения и raphaelTest.html — песочница, которую можно запустить локально с любым статическим сервером. Есть и книги: Learning Raphael JS Vector Graphics и Instant RaphaelJS Starter.
Какие ещё проекты созданы вокруг Raphaël?В README перечислены шесть связанных проектов: graphael, raphael.boilerplate, backbone.raphael, mapael, snap и react-raphael — в том числе интеграции с Backbone и 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