fabric 6.5.3 → 6.5.4

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [next]
 
+## [6.5.4]
+
+- docs() perf(): Reorder caching conditions for most common scenario and docs fixes. [#10366](https://github.com/fabricjs/fabric.js/pull/10366)
+
 ## [6.5.3]
 
 - fix(ColorMatrix): Restore correct alpha for JS colorMatrix filter [#10313](https://github.com/fabricjs/fabric.js/pull/10313)

package/CONTRIBUTING.md

@@ -254,7 +254,7 @@ Don't forget to unlink the package once you're done.
 [website]: http://fabricjs.com/
 [docs]: http://fabricjs.com/docs
 [demos]: http://fabricjs.com/demos/
-[gotchas]: http://fabricjs.com/fabric-gotchas
+[gotchas]: https://fabricjs.com/docs/old-docs/gotchas/
 [demo_file]: https://github.com/fabricjs/fabricjs.com/blob/gh-pages/posts/demos/_posts/2020-2-15-custom-control-render.md
 [jsfiddles]: https://jsfiddle.net/user/fabricjs/fiddles/
 [codepens]: https://codepen.io/tag/fabricjs

package/README.md

@@ -5,6 +5,7 @@
 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)
 
@@ -42,8 +43,8 @@ A **simple and powerful Javascript HTML5 canvas library**.
 - 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](#migrating-to-v6)
-- [Unit tested](CONTRIBUTING.md#%F0%9F%A7%AA%20testing)
+- Typed and modular
+- [Unit tested](CONTRIBUTING.md#-testing)
 
 #### Supported Browsers/Environments
 
@@ -58,14 +59,16 @@ A **simple and powerful Javascript HTML5 canvas library**.
 |    IE11     |        ❌         |
 |   Node.js   |        ✔️         | [Node.js installation](#nodejs) |
 
-Fabric.js Does not use transpilation by default, 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.
+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
 
 ```bash
 $ npm install fabric --save
-// or
+# or use yarn
 $ yarn add fabric
+# or use pnpm
+$ pnpm install fabric
 ```
 
 #### Browser
@@ -114,7 +117,7 @@ import { fabric } from 'fabric';
 
 </details>
 
-<details><summary><b>ReactJS</b></summary>
+<details><summary><b>React.js</b></summary>
 
 ```tsx
 import React, { useEffect, useRef } from 'react';
@@ -224,7 +227,7 @@ See our ready to use [templates](./.codesandbox/templates/).
 [codepens]: https://codepen.io/tag/fabricjs
 [contributors]: https://github.com/fabricjs/fabric.js/graphs/contributors
 [demos]: http://fabricjs.com/demos/
-[gotchas]: http://fabricjs.com/fabric-gotchas
+[gotchas]: https://fabricjs.com/docs/old-docs/gotchas/
 [html-to-image]: https://github.com/bubkoo/html-to-image
 [jsdelivr]: https://www.jsdelivr.com/package/npm/fabric
 [jsdom]: https://github.com/jsdom/jsdom

package/dist/index.js

@@ -411,7 +411,7 @@
   }
   const cache = new Cache();
 
-  var version = "6.5.3";
+  var version = "6.5.4";
 
   // use this syntax so babel plugin see this import here
   const VERSION = version;
@@ -7129,7 +7129,7 @@
     }
 
     /**
-     * When set to `true`, force the object to have its own cache, even if it is inside a group
+     * When returns `true`, force the object to have its own cache, even if it is inside a group
      * it may be needed when your object behave in a particular way on the cache and always needs
      * its own isolated canvas to render correctly.
      * Created to be overridden
@@ -7137,6 +7137,7 @@
      * @returns Boolean
      */
     needsItsOwnCache() {
+      // TODO re-evaluate this shadow condition
       if (this.paintFirst === STROKE && this.hasFill() && this.hasStroke() && !!this.shadow) {
         return true;
       }
@@ -7150,13 +7151,13 @@
      * Decide if the object should cache or not. Create its own cache level
      * objectCaching is a global flag, wins over everything
      * needsItsOwnCache should be used when the object drawing method requires
-     * a cache step. None of the fabric classes requires it.
+     * a cache step.
      * Generally you do not cache objects in groups because the group outside is cached.
      * Read as: cache if is needed, or if the feature is enabled but we are not already caching.
      * @return {Boolean}
      */
     shouldCache() {
-      this.ownCaching = this.needsItsOwnCache() || this.objectCaching && (!this.parent || !this.parent.isOnACache());
+      this.ownCaching = this.objectCaching && (!this.parent || !this.parent.isOnACache()) || this.needsItsOwnCache();
       return this.ownCaching;
     }
 
@@ -7256,7 +7257,10 @@
     }
 
     /**
-     * Check if cache is dirty
+     * Check if cache is dirty and if is dirty clear the context.
+     * This check has a big side effect, it changes the underlying cache canvas if necessary.
+     * Do not call this method on your own to check if the cache is dirty, because if it is,
+     * it is also going to wipe the cache. This is badly designed and needs to be fixed.
      * @param {Boolean} skipCanvas skip canvas checks because this object is painted
      * on parent canvas.
      */
@@ -11668,9 +11672,9 @@
     }
 
     /**
-     * Decide if the object should cache or not. Create its own cache level
+     * Decide if the group should cache or not. Create its own cache level
      * needsItsOwnCache should be used when the object drawing method requires
-     * a cache step. None of the fabric classes requires it.
+     * a cache step.
      * Generally you do not cache objects in groups because the group is already cached.
      * @return {Boolean}
      */
@@ -23668,11 +23672,7 @@
     }
 
     /**
-     * Decide if the object should cache or not. Create its own cache level
-     * objectCaching is a global flag, wins over everything
-     * needsItsOwnCache should be used when the object drawing method requires
-     * a cache step. None of the fabric classes requires it.
-     * Generally you do not cache objects in groups because the group outside is cached.
+     * Decide if the object should cache or not. The Active selection never caches
      * @return {Boolean}
      */
     shouldCache() {
@@ -24523,11 +24523,11 @@
     }
 
     /**
-     * Decide if the object should cache or not. Create its own cache level
+     * Decide if the FabricImage should cache or not. Create its own cache level
      * needsItsOwnCache should be used when the object drawing method requires
-     * a cache step. None of the fabric classes requires it.
+     * a cache step.
      * Generally you do not cache objects in groups because the group outside is cached.
-     * This is the special image version where we would like to avoid caching where possible.
+     * This is the special Image version where we would like to avoid caching where possible.
      * Essentially images do not benefit from caching. They may require caching, and in that
      * case we do it. Also caching an image usually ends in a loss of details.
      * A full performance audit should be done.