fabric.js README

The project's README from github.com/fabricjs/fabric.js. As one markdown file: README.md.

Fabric.js

A simple and powerful Javascript HTML5 canvas library.

Special Thanks

Here is a section for recognition of companies or individuals that support fabricJS with a sponsorship

Atlascloud 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

Features

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

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:

# Browser applications
npm install @fabricjs/browser

# Node.js applications
npm install @fabricjs/node

The legacy fabric package remains supported for existing applications:

$ 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:

import { Canvas } from 'fabric';
import { StaticCanvas } from 'fabric/node';

New applications should prefer the explicit entrypoints:

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:

New ESM applications should continue to import @fabricjs/browser or @fabricjs/node directly.

Browser

cdnjs jsdelivr

See browser modules for using es6 imports in the browser or use a dedicated bundler.

Node.js

We strongly recommend to run your applications only LTS versions of node.

Said so the minimum supported version of node is 20. We bump up the minimum version of node with a Major release only when the dependencies force us to do so.

Fabric.js depends on node-canvas for a canvas implementation (HTMLCanvasElement replacement) and jsdom for a window implementation on node. This means that you may encounter node-canvas limitations and bugs.

Follow these instructions to get node-canvas up and running.

Quick Start

// Preferred entrypoints for new applications
import { Canvas } from '@fabricjs/browser';
import { StaticCanvas } from '@fabricjs/node';
// Supported compatibility entrypoints
import { Canvas } from 'fabric';
import { StaticCanvas } from 'fabric/node';

// v5 compatibility
import { fabric } from 'fabric';
Plain HTML
<canvas id="canvas" width="300" height="300"></canvas>

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/index.js"></script>
<script>
  const canvas = new fabric.Canvas('canvas');
  const rect = new fabric.Rect({
    top: 100,
    left: 100,
    width: 60,
    height: 70,
    fill: 'red',
  });
  canvas.add(rect);
</script>
React.js
import React, { useEffect, useRef } from 'react';
import * as fabric from 'fabric'; // v6
import { fabric } from 'fabric'; // v5

export const FabricJSCanvas = () => {
  const canvasEl = useRef<HTMLCanvasElement>(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 <canvas width="300" height="300" ref={canvasEl}/>;
};
Node.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(`<img src="${imageData}" />`);
      res.end();
    }
  })
  .listen(port, (err) => {
    if (err) throw err;
    console.log(
      `> Ready on http://localhost:${port}, http://localhost:${port}/view, http://localhost:${port}/download`,
    );
  });

See our ready to use templates.


Other Solutions

Project Description
Three.js 3D graphics
PixiJS WebGL renderer
Konva Similar features
html-to-image HTML to image/canvas

More Resources

Credits Patreon

fabric.js (fabricjs/fabric.js)

Searching Database…

31.5K ·GitHub
这是什么?Fabric.js 是一个用于操作 HTML5 canvas 的 JavaScript 库,可以创建和操作可交互的图形、文字和图片,并在 SVG 与 canvas 之间进行转换。
这是独立应用,还是我要加入自己项目里的库?这是一个库,你需要将它导入到自己的网页或 Node.js 应用中,它本身不是独立程序。它按模块拆分为多个包:@fabricjs/browser 用于浏览器应用,@fabricjs/node 用于服务器端,@fabricjs/core 则是两者共用的、与运行环境无关的核心运行时。
怎么把它添加到项目里?安装对应环境的包:新的浏览器应用使用 @fabricjs/browser,Node.js 应用使用 @fabricjs/node。已有项目可以继续使用旧版 fabric 包,它为兼容性而重新导出了 @fabricjs/browser。
使用 Node 包是否需要特定的 Node.js 版本?需要。项目的 engines 字段要求 Node.js 20.0.0 或更高版本,才能构建和运行 Node 专用的包。
安装时有哪些需要注意的坑?不支持 IE11 和 Edge Legacy 等旧环境;fabric 和所有 @fabricjs/ 包都必须保持版本一致,因为版本不匹配可能会加载出不同的运行时,从而引发 bug。
我能只在服务器上渲染 canvas,而不仅限于浏览器吗?可以。使用 @fabricjs/node,你可以在 Node.js 进程中(例如在 HTTP 服务器里)创建 fabric.Canvas,并将其输出为 PNG 或 data URL。
它开箱即用支持哪些功能?内置的对象交互功能,如缩放、移动、旋转、倾斜和编组,以及动画、图像滤镜、渐变、图案和画笔,并支持 JPG、PNG、JSON 和 SVG 的导入与导出。
它与 Three.js、PixiJS 或 Konva 有什么不同?Fabric.js 是一个二维 canvas 对象模型,内置 SVG 和 JSON 序列化;Three.js 面向三维图形,PixiJS 是一个 WebGL 渲染器,Konva 的二维功能与 Fabric 相似,但不专注于 SVG 解析。
Creator
fabricjs
Size
255.2 MB
Stars
31.5K
Age
16y
Commits · 90 Days