Skip to content

Latest commit

 

History

History
206 lines (136 loc) · 10.5 KB

README.md

File metadata and controls

206 lines (136 loc) · 10.5 KB
Raw

Fabric

Build Status

Code Climate

Fabric.js is a framework that makes it easy to work with HTML5 canvas element. It is an interactive object model on top of canvas element. It is also an SVG-to-canvas parser.

Using Fabric.js, you can create and populate objects on canvas; objects like simple geometrical shapes — rectangles, circles, ellipses, polygons, or more complex shapes consisting of hundreds or thousands of simple paths. You can then scale, move, and rotate these objects with the mouse; modify their properties — color, transparency, z-index, etc. You can also manipulate these objects altogether — grouping them with a simple mouse selection.

Contributions are very much welcome!

Goals

  • Unit tested (2300+ tests at the moment)
  • Modular (~60 small "classes", modules, mixins)
  • Cross-browser
  • Fast
  • Encapsulated in one object
  • No browser sniffing for critical functionality
  • Runs under ES5 strict mode
  • Runs on a server under Node.js (0.6, 0.8, 0.10) (see Node.js limitations)

Supported browsers

  • Firefox 2+
  • Safari 3+
  • Opera 9.64+
  • Chrome (all versions should work)
  • IE9, IE10, IE11

With help of Explorer Canvas

  • IE8 (incomplete — about 17 failing tests at the moment)
  • IE7,6 (incomplete - about 27 failing tests at the moment)

See Fabric limitations in Old IE.

You can run automated unit tests right in the browser.

History

Fabric.js started as a foundation for design editor on printio.ru — interactive online store with ability to create your own designs. The idea was to create Javascript-based editor, which would make it easy to manipulate vector shapes and images on T-Shirts. Since performance was one of the most critical requirements, we chose canvas over SVG. While SVG is excellent with static shapes, it's not as performant as canvas when it comes to dynamic manipulation of objects (movement, scaling, rotation, etc.). Fabric.js was heavily inspired by Ernest Delgado's canvas experiment. In fact, code from Ernest's experiment was the foundation of an entire framework. Later, Fabric.js grew into a collection of distinct object types and got an SVG-to-canvas parser.

Install with bower

$ bower install fabric

Building

  1. Install Node.js

  2. Build distribution file [~77K minified, ~20K gzipped]

     $ node build.js

    2.1 Or build a custom distribution file, by passing (comma separated) module names to be included.

       $ node build.js modules=text,serialization,parser
   // or
   $ node build.js modules=text
   // or
   $ node build.js modules=parser,text
   // etc.

    By default (when none of the modules are specified) only basic functionality is included. See the list of modules below for more information on each one of them. Note that default distribution has support for static canvases only.

    To get minimal distribution with interactivity, make sure to include corresponding module:

       $ node build.js modules=interaction

    2.2 You can also include all modules like so:

       $ node build.js modules=ALL

    2.3 You can exclude a few modules like so:

       $ node build.js modules=ALL exclude=gestures,image_filters

  3. Create a minified distribution file

     # Using YUICompressor (default option)
 $ node build.js modules=... minifier=yui

 # or Google Closure Compiler
 $ node build.js modules=... minifier=closure

  4. Enable AMD support via require.js (requires uglify)

     $ node build.js requirejs modules=...

  5. Create source map file for better productive debugging (requires uglify or google closure compiler).
    More information about source maps.

     $ node build.js sourcemap modules=...

    If you use google closure compiler you have to add sourceMappingURL manually at the end of the minified file all.min.js (see issue https://code.google.com/p/closure-compiler/issues/detail?id=941).

     //# sourceMappingURL=all.min.js.map

Demos

Documentation

Documentation is always available at http://fabricjs.com/docs/.

Also see official 4-part intro series, presentation from BK.js and presentation from Falsy Values for an overview of fabric.js, how it works, and its features.

Optional modules

These are the optional modules that could be specified for inclusion, when building custom version of fabric:

  • text — Adds support for static text (fabric.Text)
  • itext — Adds support for interactive text (fabric.IText)
  • serialization — Adds support for loadFromJSON, loadFromDatalessJSON, and clone methods on fabric.Canvas
  • interaction — Adds support for interactive features of fabric — selecting/transforming objects/groups via mouse/touch devices.
  • parser — Adds support for fabric.parseSVGDocument, fabric.loadSVGFromURL, and fabric.loadSVGFromString
  • image_filters — Adds support for image filters, such as grayscale of white removal.
  • easing — Adds support for animation easing functions
  • node — Adds support for running fabric under node.js, with help of jsdom and node-canvas libraries.
  • freedrawing — Adds support for free drawing
  • gestures — Adds support for multitouch gestures with help of Event.js
  • object_straightening — Adds support for rotating an object to one of 0, 90, 180, 270, etc. depending on which is angle is closer.
  • animation — Adds support for animation (fabric.util.animate, fabric.util.requestAnimFrame, fabric.Object#animate, fabric.Canvas#fxCenterObjectH/#fxCenterObjectV/#fxRemove)

Additional flags for build script are:

  • requirejs — Makes fabric requirejs AMD-compatible in dist/all.js. Note: an unminified, requirejs-compatible version is always created in dist/all.require.js
  • no-strict — Strips "use strict" directives from source
  • no-svg-export — Removes svg exporting functionality
  • no-es5-compat - Removes ES5 compat methods (Array.prototype., String.prototype., Function.prototype.*)
  • sourcemap - Generates a sourceMap file and adds the sourceMappingURL (only if uglifyjs is used) to dist/all.min.js

For example:

node build.js modules=ALL exclude=json no-strict no-svg-export

Examples of use

Adding red rectangle to canvas

<canvas id="canvas" width="300" height="300"></canvas>
...
var canvas = new fabric.Canvas('canvas');

var rect = new fabric.Rect({
  top: 100,
  left: 100,
  width: 60,
  height: 70,
  fill: 'red'
});

canvas.add(rect);

Staying in touch

Follow @fabric.js or @kangax on twitter.

Questions, suggestions — fabric.js on Google Groups.

See Fabric questions on Stackoverflow, Fabric snippets on jsfiddle or codepen.io.

Get help in Fabric's IRC channel — irc://irc.freenode.net/#fabric.js

Credits

  • Ernest Delgado for the original idea of manipulating images on canvas.
  • Maxim "hakunin" Chernyak for ideas, and help with various parts of the library throughout its life.
  • Sergey Nisnevich for help with geometry logic.
  • Stefan Kienzle for help with bugs, features, documentation, github issues
  • Github contributors: @Kingsquare, @cleercode, @jarek-itmore, @sunrei, @khronnuz, @ollym, @garg, @sjpemberton09, @willmcneilly, @davidjrice, @coulix, and more

MIT License

Copyright (c) 2008-2013 Printio (Juriy Zaytsev, Maxim Chernyak)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.