# Fabric.js
A **simple and powerful Javascript HTML5 canvas library**.
- [**Website**][website]
- [**Old V5 documentation**](https://fabric5.fabricjs.com)
- [**GOTCHAS**][gotchas]
- [**Contributing, Developing and More**](CONTRIBUTING.md)
## Special Thanks
Here is a section for recognition of companies or individuals that support fabricJS with a sponsorship
Atlas Cloud is a full-modal AI inference platform that gives developers a single AI API to access video generation, image generation, and LLM APIs. Instead of managing multiple vendor integrations, you connect once and get unified access to 300+ curated models across all modalities.
Check out Atlas Cloud's new coding plan promotion for more budget-friendly API access：[https://www.atlascloud.ai/console/coding-plan](https://www.atlascloud.ai/console/coding-plan?utm_source=github&utm_medium=link&utm_campaign=fabric.js)
## Features
- Out of the box interactions such as scale, move, rotate, skew, group...
- Built in shapes, controls, animations, image filters, gradients, patterns, brushes...
- `JPG`, `PNG`, `JSON` and `SVG` i/o
- Typed and modular
- [Unit tested](CONTRIBUTING.md#-testing)
- Security efforts [](https://www.bestpractices.dev/projects/12579)
#### Supported Browsers/Environments
| Context | Supported Version | Notes |
| :---------: | :---------------: | ------------------------------- |
| Firefox | ✔️ | 58 |
| Safari | ✔️ | 11 |
| Opera | ✔️ | chromium based |
| Chrome | ✔️ | 64 |
| Edge | ✔️ | chromium based |
| Edge Legacy | ❌ |
| IE11 | ❌ |
| Node.js | ✔️ | [Node.js installation](#nodejs) |
Fabric.js does not use polyfills by default, or tries to keep it at minimum. the browser version we support is determined by the level of canvas api we want to use and some js syntax. While JS can be easily transpiled, canvas API can't.
## Installation
For new applications, install the environment-specific package:
```bash
# Browser applications
npm install @fabricjs/browser
# Node.js applications
npm install @fabricjs/node
```
The legacy `fabric` package remains supported for existing applications:
```bash
$ npm install fabric --save
# or use yarn
$ yarn add fabric
# or use pnpm
$ pnpm add fabric
```
## Packages and migration
| Package | Role |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `fabric` | Legacy compatibility facade. It re-exports `@fabricjs/browser`. |
| `@fabricjs/browser` | Preferred entrypoint for new browser applications. |
| `@fabricjs/node` | Preferred entrypoint for new Node.js applications. It owns the Node-specific dependencies. |
| `@fabricjs/core` | Shared, environment-neutral runtime used by the browser and Node packages. It is intended for advanced and shared dependencies. |
| Extension packages | Optional features imported individually, such as `@fabricjs/aligning-guidelines`. |
Existing imports continue to work:
```js
import { Canvas } from 'fabric';
import { StaticCanvas } from 'fabric/node';
```
New applications should prefer the explicit entrypoints:
```js
import { Canvas } from '@fabricjs/browser';
import { StaticCanvas } from '@fabricjs/node';
import { AligningGuidelines } from '@fabricjs/aligning-guidelines';
```
The `fabric` and `fabric/node` facades share the same class identities as
their corresponding workspace packages. Keep `fabric` and every
`@fabricjs/*` package on matching versions; mixing mismatched versions can
load separate runtimes.
`@fabricjs/core` has no Node-specific runtime dependencies, but it is not a
DOM-free API. Advanced consumers using core APIs that touch DOM or canvas must
provide a suitable environment implementation.
### Legacy distribution files
The ESM `fabric` and `fabric/node` entries are small compatibility facades over
the workspace packages. The legacy standalone files remain available for
existing usage:
- `dist/index.js` and `dist/index.min.js` are full browser UMD builds from
`@fabricjs/browser`, for `
```
React.js
```tsx
import React, { useEffect, useRef } from 'react';
import * as fabric from 'fabric'; // v6
import { fabric } from 'fabric'; // v5
export const FabricJSCanvas = () => {
const canvasEl = useRef(null);
useEffect(() => {
const options = { ... };
const canvas = new fabric.Canvas(canvasEl.current, options);
// make the fabric.Canvas instance available to your app
updateCanvasContext(canvas);
return () => {
updateCanvasContext(null);
canvas.dispose();
}
}, []);
return Node.js
```js
import http from 'http';
import * as fabric from 'fabric/node'; // v6
import { fabric } from 'fabric'; // v5
const port = 8080;
http
.createServer((req, res) => {
const canvas = new fabric.Canvas(null, { width: 100, height: 100 });
const rect = new fabric.Rect({ width: 20, height: 50, fill: '#ff0000' });
const text = new fabric.Text('fabric.js', { fill: 'blue', fontSize: 24 });
canvas.add(rect, text);
canvas.renderAll();
if (req.url === '/download') {
res.setHeader('Content-Type', 'image/png');
res.setHeader('Content-Disposition', 'attachment; filename="fabric.png"');
canvas.createPNGStream().pipe(res);
} else if (req.url === '/view') {
canvas.createPNGStream().pipe(res);
} else {
const imageData = canvas.toDataURL();
res.writeHead(200, '', { 'Content-Type': 'text/html' });
res.write(`
`);
res.end();
}
})
.listen(port, (err) => {
if (err) throw err;
console.log(
`> Ready on http://localhost:${port}, http://localhost:${port}/view, http://localhost:${port}/download`,
);
});
```