@bwp-web/canvas 0.8.2 → 0.8.3

package/dist/context/EditCanvasContext.d.ts

@@ -12,12 +12,23 @@ export interface EditCanvasProviderProps {
  * to all descendants via React context.
  *
  * Use {@link useEditCanvasContext} in any descendant to access `canvasRef`,
- * `isDirty`, `viewport`, `setMode`, `setBackground`, and every other value
- * that `useEditCanvas` returns — without prop drilling or bridge contexts.
+ * `isDirty`, `objects`, `isLoading`, `lockLightMode`, `viewport`,
+ * `setMode`, `setBackground`, and every other value that `useEditCanvas`
+ * returns — without prop drilling or bridge contexts.
+ *
+ * Descendant components can also use {@link ObjectOverlay},
+ * {@link useCanvasEvents}, {@link useCanvasTooltip}, and
+ * {@link useCanvasClick} without passing `canvasRef` explicitly — they
+ * read it from the nearest provider automatically.
  *
  * @example
  * ```tsx
- * <EditCanvasProvider options={{ trackChanges: true, history: true }}>
+ * <EditCanvasProvider options={{
+ *   canvasData: savedJson,
+ *   invertBackground: isDarkMode,
+ *   trackChanges: true,
+ *   history: true,
+ * }}>
  *   <MyCanvas />
  *   <MySidebar />
  *   <MyToolbar />
@@ -42,4 +53,9 @@ export declare function EditCanvasProvider({ options, children, }: EditCanvasPro
  * Throws if called outside of a provider.
  */
 export declare function useEditCanvasContext(): EditCanvasContextValue;
+/**
+ * Like {@link useEditCanvasContext} but returns `null` instead of throwing
+ * when called outside of an {@link EditCanvasProvider}.
+ */
+export declare function useEditCanvasContextSafe(): EditCanvasContextValue | null;
 //# sourceMappingURL=EditCanvasContext.d.ts.map

package/dist/context/EditCanvasContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EditCanvasContext.d.ts","sourceRoot":"","sources":["../../src/context/EditCanvasContext.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA6B,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAClE,OAAO,EACL,aAAa,EACb,KAAK,oBAAoB,EAC1B,MAAM,wBAAwB,CAAC;AAEhC,2EAA2E;AAC3E,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAItE,MAAM,WAAW,uBAAuB;IACtC,sEAAsE;IACtE,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,OAAO,EACP,QAAQ,GACT,EAAE,uBAAuB,2CAOzB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,sBAAsB,CAQ7D"}
+{"version":3,"file":"EditCanvasContext.d.ts","sourceRoot":"","sources":["../../src/context/EditCanvasContext.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA6B,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAClE,OAAO,EACL,aAAa,EACb,KAAK,oBAAoB,EAC1B,MAAM,wBAAwB,CAAC;AAEhC,2EAA2E;AAC3E,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAItE,MAAM,WAAW,uBAAuB;IACtC,sEAAsE;IACtE,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,OAAO,EACP,QAAQ,GACT,EAAE,uBAAuB,2CAOzB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,sBAAsB,CAQ7D;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,IAAI,sBAAsB,GAAG,IAAI,CAExE"}

package/dist/context/ViewCanvasContext.d.ts

@@ -12,18 +12,28 @@ export interface ViewCanvasProviderProps {
  * to all descendants via React context.
  *
  * Use {@link useViewCanvasContext} in any descendant to access `canvasRef`,
- * `viewport`, `setObjectStyle`, and every other value that `useViewCanvas`
- * returns — without prop drilling or bridge contexts.
+ * `viewport`, `objects`, `isLoading`, `setObjectStyle`, and every other
+ * value that `useViewCanvas` returns — without prop drilling or bridge
+ * contexts.
+ *
+ * Descendant components can also use {@link ObjectOverlay},
+ * {@link useCanvasEvents}, {@link useCanvasTooltip}, and
+ * {@link useCanvasClick} without passing `canvasRef` explicitly — they
+ * read it from the nearest provider automatically.
  *
  * @example
  * ```tsx
- * <ViewCanvasProvider options={{ scaledStrokes: true }}>
+ * <ViewCanvasProvider options={{
+ *   canvasData: savedJson,
+ *   invertBackground: isDarkMode,
+ *   scaledStrokes: true,
+ * }}>
  *   <MyCanvas />
  *   <MyToolbar />
  * </ViewCanvasProvider>
  *
  * function MyCanvas() {
- *   const { onReady } = useViewCanvasContext();
+ *   const { onReady, objects, isLoading } = useViewCanvasContext();
  *   return <Canvas onReady={onReady} />;
  * }
  *
@@ -41,4 +51,9 @@ export declare function ViewCanvasProvider({ options, children, }: ViewCanvasPro
  * Throws if called outside of a provider.
  */
 export declare function useViewCanvasContext(): ViewCanvasContextValue;
+/**
+ * Like {@link useViewCanvasContext} but returns `null` instead of throwing
+ * when called outside of a {@link ViewCanvasProvider}.
+ */
+export declare function useViewCanvasContextSafe(): ViewCanvasContextValue | null;
 //# sourceMappingURL=ViewCanvasContext.d.ts.map

package/dist/context/ViewCanvasContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ViewCanvasContext.d.ts","sourceRoot":"","sources":["../../src/context/ViewCanvasContext.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA6B,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAClE,OAAO,EACL,aAAa,EACb,KAAK,oBAAoB,EAC1B,MAAM,wBAAwB,CAAC;AAEhC,2EAA2E;AAC3E,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAItE,MAAM,WAAW,uBAAuB;IACtC,sEAAsE;IACtE,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,OAAO,EACP,QAAQ,GACT,EAAE,uBAAuB,2CAOzB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,sBAAsB,CAQ7D"}
+{"version":3,"file":"ViewCanvasContext.d.ts","sourceRoot":"","sources":["../../src/context/ViewCanvasContext.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA6B,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAClE,OAAO,EACL,aAAa,EACb,KAAK,oBAAoB,EAC1B,MAAM,wBAAwB,CAAC;AAEhC,2EAA2E;AAC3E,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAItE,MAAM,WAAW,uBAAuB;IACtC,sEAAsE;IACtE,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,OAAO,EACP,QAAQ,GACT,EAAE,uBAAuB,2CAOzB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,sBAAsB,CAQ7D;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,IAAI,sBAAsB,GAAG,IAAI,CAExE"}

package/dist/context/index.d.ts

@@ -2,4 +2,5 @@ export { EditCanvasProvider, useEditCanvasContext } from './EditCanvasContext';
 export type { EditCanvasProviderProps, EditCanvasContextValue, } from './EditCanvasContext';
 export { ViewCanvasProvider, useViewCanvasContext } from './ViewCanvasContext';
 export type { ViewCanvasProviderProps, ViewCanvasContextValue, } from './ViewCanvasContext';
+export { useCanvasRef } from './useCanvasRef';
 //# sourceMappingURL=index.d.ts.map

package/dist/context/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/context/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,YAAY,EACV,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,YAAY,EACV,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/context/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,YAAY,EACV,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,YAAY,EACV,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/context/useCanvasRef.d.ts

@@ -0,0 +1,13 @@
+import type { RefObject } from 'react';
+import type { Canvas as FabricCanvas } from 'fabric';
+/**
+ * Read `canvasRef` from the nearest {@link ViewCanvasProvider} or
+ * {@link EditCanvasProvider}.
+ *
+ * Returns `null` if neither provider is present in the tree.
+ *
+ * Both context hooks are called unconditionally (Rules-of-Hooks compliant).
+ * In practice only one provider will be active at a time.
+ */
+export declare function useCanvasRef(): RefObject<FabricCanvas | null> | null;
+//# sourceMappingURL=useCanvasRef.d.ts.map

package/dist/context/useCanvasRef.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCanvasRef.d.ts","sourceRoot":"","sources":["../../src/context/useCanvasRef.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,KAAK,EAAE,MAAM,IAAI,YAAY,EAAE,MAAM,QAAQ,CAAC;AAIrD;;;;;;;;GAQG;AACH,wBAAgB,YAAY,IAAI,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,IAAI,CAIpE"}

package/dist/hooks/useCanvasClick.d.ts

@@ -6,6 +6,20 @@ export interface UseCanvasClickOptions {
     /** Maximum duration in milliseconds for the gesture to count as a click. Default: 300. */
     maxDuration?: number;
 }
+/**
+ * Distinguish clicks from pan gestures on a canvas, using the `canvasRef`
+ * from the nearest {@link ViewCanvasProvider} or {@link EditCanvasProvider}.
+ *
+ * @example
+ * ```tsx
+ * useCanvasClick((target) => {
+ *   if (target?.data?.id) {
+ *     navigate(`/locations/${target.data.id}`);
+ *   }
+ * });
+ * ```
+ */
+export declare function useCanvasClick(onClick: (target: FabricObject | undefined) => void, options?: UseCanvasClickOptions): void;
 /**
  * Distinguish clicks from pan gestures on a canvas.
  *

package/dist/hooks/useCanvasClick.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCanvasClick.d.ts","sourceRoot":"","sources":["../../src/hooks/useCanvasClick.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAC1D,OAAO,KAAK,EACV,MAAM,IAAI,YAAY,EAEtB,YAAY,EACb,MAAM,QAAQ,CAAC;AAEhB,MAAM,WAAW,qBAAqB;IACpC,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0FAA0F;IAC1F,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAC5B,SAAS,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,EACzC,OAAO,EAAE,CAAC,MAAM,EAAE,YAAY,GAAG,SAAS,KAAK,IAAI,EACnD,OAAO,CAAC,EAAE,qBAAqB,GAC9B,IAAI,CA2DN"}
+{"version":3,"file":"useCanvasClick.d.ts","sourceRoot":"","sources":["../../src/hooks/useCanvasClick.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAC1D,OAAO,KAAK,EACV,MAAM,IAAI,YAAY,EAEtB,YAAY,EACb,MAAM,QAAQ,CAAC;AAGhB,MAAM,WAAW,qBAAqB;IACpC,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0FAA0F;IAC1F,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,CAAC,MAAM,EAAE,YAAY,GAAG,SAAS,KAAK,IAAI,EACnD,OAAO,CAAC,EAAE,qBAAqB,GAC9B,IAAI,CAAC;AACR;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAC5B,SAAS,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,EACzC,OAAO,EAAE,CAAC,MAAM,EAAE,YAAY,GAAG,SAAS,KAAK,IAAI,EACnD,OAAO,CAAC,EAAE,qBAAqB,GAC9B,IAAI,CAAC"}

package/dist/hooks/useCanvasEvents.d.ts

@@ -15,6 +15,19 @@ import type { Canvas as FabricCanvas, CanvasEvents } from 'fabric';
 export type CanvasEventHandlers = {
     [K in keyof CanvasEvents]?: (event: CanvasEvents[K]) => void;
 };
+/**
+ * Subscribe to Fabric canvas events using the `canvasRef` from the nearest
+ * {@link ViewCanvasProvider} or {@link EditCanvasProvider}.
+ *
+ * @example
+ * ```tsx
+ * useCanvasEvents({
+ *   'mouse:wheel': hideTooltip,
+ *   'object:moving': hideTooltip,
+ * });
+ * ```
+ */
+export declare function useCanvasEvents(events: CanvasEventHandlers): void;
 /**
  * Subscribe to Fabric canvas events with automatic cleanup.
  *

package/dist/hooks/useCanvasEvents.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCanvasEvents.d.ts","sourceRoot":"","sources":["../../src/hooks/useCanvasEvents.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAC1D,OAAO,KAAK,EAAE,MAAM,IAAI,YAAY,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEnE;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,mBAAmB,GAAG;KAC/B,CAAC,IAAI,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI;CAC7D,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAC7B,SAAS,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,EACzC,MAAM,EAAE,mBAAmB,GAC1B,IAAI,CA8BN"}
+{"version":3,"file":"useCanvasEvents.d.ts","sourceRoot":"","sources":["../../src/hooks/useCanvasEvents.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAC1D,OAAO,KAAK,EAAE,MAAM,IAAI,YAAY,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGnE;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,mBAAmB,GAAG;KAC/B,CAAC,IAAI,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI;CAC7D,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI,CAAC;AACnE;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAC7B,SAAS,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,EACzC,MAAM,EAAE,mBAAmB,GAC1B,IAAI,CAAC"}

package/dist/hooks/useCanvasTooltip.d.ts

@@ -15,6 +15,19 @@ export interface CanvasTooltipState<T> {
         y: number;
     };
 }
+/**
+ * Track mouse hover over canvas objects and return tooltip state, using the
+ * `canvasRef` from the nearest {@link ViewCanvasProvider} or
+ * {@link EditCanvasProvider}.
+ *
+ * @example
+ * ```tsx
+ * const tooltip = useCanvasTooltip({
+ *   getContent: (obj) => obj.data ? { id: obj.data.id, type: obj.data.type } : null,
+ * });
+ * ```
+ */
+export declare function useCanvasTooltip<T>(options: UseCanvasTooltipOptions<T>): CanvasTooltipState<T>;
 /**
  * Track mouse hover over canvas objects and return tooltip state.
  *

package/dist/hooks/useCanvasTooltip.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCanvasTooltip.d.ts","sourceRoot":"","sources":["../../src/hooks/useCanvasTooltip.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AACpE,OAAO,KAAK,EACV,MAAM,IAAI,YAAY,EAEtB,YAAY,EACb,MAAM,QAAQ,CAAC;AAEhB,MAAM,WAAW,uBAAuB,CAAC,CAAC;IACxC,wFAAwF;IACxF,UAAU,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,CAAC,GAAG,IAAI,CAAC;CAC7C;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,gDAAgD;IAChD,OAAO,EAAE,OAAO,CAAC;IACjB,4EAA4E;IAC5E,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;IAClB,gFAAgF;IAChF,QAAQ,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACpC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,SAAS,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,EACzC,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAClC,kBAAkB,CAAC,CAAC,CAAC,CA0EvB"}
+{"version":3,"file":"useCanvasTooltip.d.ts","sourceRoot":"","sources":["../../src/hooks/useCanvasTooltip.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AACpE,OAAO,KAAK,EACV,MAAM,IAAI,YAAY,EAEtB,YAAY,EACb,MAAM,QAAQ,CAAC;AAGhB,MAAM,WAAW,uBAAuB,CAAC,CAAC;IACxC,wFAAwF;IACxF,UAAU,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,CAAC,GAAG,IAAI,CAAC;CAC7C;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,gDAAgD;IAChD,OAAO,EAAE,OAAO,CAAC;IACjB,4EAA4E;IAC5E,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;IAClB,gFAAgF;IAChF,QAAQ,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACpC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAClC,kBAAkB,CAAC,CAAC,CAAC,CAAC;AACzB;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,SAAS,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,EACzC,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAClC,kBAAkB,CAAC,CAAC,CAAC,CAAC"}

package/dist/hooks/useEditCanvas.d.ts

@@ -4,7 +4,7 @@ import { type ObjectAlignmentOptions, type RotationSnapOptions } from '../alignm
 import { type VertexEditOptions } from '../interactions';
 import { type ResizeImageOptions } from '../background';
 import { type HistoryOptions } from '../history';
-import type { ModeSetup } from '../types';
+import type { ModeSetup, CanvasJSON } from '../types';
 export interface UseEditCanvasOptions {
     /** Configure pan and zoom. Pass `false` to disable, or options to customize. Default: enabled. */
     panAndZoom?: boolean | PanAndZoomOptions;
@@ -59,7 +59,7 @@ export interface UseEditCanvasOptions {
      * Listens for `object:added`, `object:removed`, `object:modified`, and
      * `background:modified` events. Call `resetDirty()` after a successful
      * save to clear the flag, or `markDirty()` to set it manually.
-     * Default: disabled.
+     * Pass `false` to disable. Default: enabled.
      */
     trackChanges?: boolean;
     /**
@@ -73,6 +73,23 @@ export interface UseEditCanvasOptions {
      * Default: disabled.
      */
     history?: boolean | HistoryOptions;
+    /**
+     * Canvas data to load automatically after initialisation.
+     * When provided, `loadCanvas` is called internally before the user's
+     * `onReady` callback, and the resulting objects are available via the
+     * returned `objects` array.
+     */
+    canvasData?: CanvasJSON | object;
+    /**
+     * Filter function for loaded objects. Passed to `loadCanvas` as
+     * `options.filter`. Only relevant when `canvasData` is provided.
+     */
+    filter?: (obj: FabricObject) => boolean;
+    /**
+     * Whether the background image should have an Invert filter applied.
+     * Reactive — changes are applied automatically without remounting.
+     */
+    invertBackground?: boolean;
 }
 /**
  * Hook that provides a batteries-included canvas experience with full
@@ -103,6 +120,10 @@ export declare function useEditCanvas(options?: UseEditCanvasOptions): {
     canvasRef: import("react").RefObject<FabricCanvas | null>;
     /** Current zoom level (reactive). */
     zoom: number;
+    /** Loaded objects (reactive). Populated when `canvasData` is provided. */
+    objects: FabricObject<Partial<import("fabric").FabricObjectProps>, import("fabric").SerializedObjectProps, import("fabric").ObjectEvents>[];
+    /** Whether canvas data is currently being loaded. */
+    isLoading: boolean;
     /** Currently selected objects (reactive). */
     selected: FabricObject<Partial<import("fabric").FabricObjectProps>, import("fabric").SerializedObjectProps, import("fabric").ObjectEvents>[];
     /** Viewport controls. */
@@ -151,7 +172,7 @@ export declare function useEditCanvas(options?: UseEditCanvasOptions): {
     setBackground: (url: string, bgOpts?: {
         preserveContrast?: boolean;
     }) => Promise<import("fabric").FabricImage<Partial<import("fabric").ImageProps>, import("fabric").SerializedImageProps, import("fabric").ObjectEvents>>;
-    /** Whether the canvas has been modified since the last `resetDirty()` call. Requires `trackChanges: true`. */
+    /** Whether the canvas has been modified since the last `resetDirty()` call. Enabled by default (disable via `trackChanges: false`). */
     isDirty: boolean;
     /** Reset the dirty flag (e.g., after a successful save). */
     resetDirty: () => void;
@@ -165,5 +186,9 @@ export declare function useEditCanvas(options?: UseEditCanvasOptions): {
     canUndo: boolean;
     /** Whether a redo operation is available (reactive). Requires `history: true`. */
     canRedo: boolean;
+    /** Whether the canvas is locked to light mode. Read from loaded canvas data. */
+    lockLightMode: boolean | undefined;
+    /** Update lockLightMode on both the canvas instance and React state. */
+    setLockLightMode: (value: boolean) => void;
 };
 //# sourceMappingURL=useEditCanvas.d.ts.map

package/dist/hooks/useEditCanvas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useEditCanvas.d.ts","sourceRoot":"","sources":["../../src/hooks/useEditCanvas.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,IAAI,YAAY,EAAE,KAAK,YAAY,EAAW,MAAM,QAAQ,CAAC;AAC5E,OAAO,EAEL,KAAK,iBAAiB,EAEtB,KAAK,YAAY,EAClB,MAAM,aAAa,CAAC;AAMrB,OAAO,EAEL,KAAK,sBAAsB,EAE3B,KAAK,mBAAmB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,EAGL,KAAK,iBAAiB,EACvB,MAAM,iBAAiB,CAAC;AAOzB,OAAO,EAGL,KAAK,kBAAkB,EAExB,MAAM,eAAe,CAAC;AACvB,OAAO,EAEL,KAAK,cAAc,EAEpB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAE1C,MAAM,WAAW,oBAAoB;IACnC,kGAAkG;IAClG,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IACzC,mIAAmI;IACnI,SAAS,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IAC7C;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAC;IAC7C;;;;;OAKG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IACzC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,qEAAqE;IACrE,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAChD;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC9B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,cAAc,CAAC;CACpC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,aAAa,CAAC,OAAO,CAAC,EAAE,oBAAoB;IAiRxD,8CAA8C;sBArMrC,YAAY;IAuMrB,oDAAoD;;IAEpD,qCAAqC;;IAErC,6CAA6C;;IAE7C,yBAAyB;;QAEvB,wCAAwC;;QAExC,wDAAwD;wBAhDjB,YAAY;QAkDnD,wFAAwF;;QAExF,2DAA2D;;QAE3D,0DAA0D;;QAE1D,uDAAuD;;QAEvD,6DAA6D;;;IAG/D,+DAA+D;;IAE/D;;;;;;;;;;;;;;OAcG;qBAvR+B,SAAS,GAAG,IAAI;IAyRlD;;;;;;;OAOG;yBA7ES,MAAM,WAAW;QAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAAE;IA+E3D,8GAA8G;;IAE9G,4DAA4D;;IAE5D,oGAAoG;;IAEpG,sDAAsD;;IAQtD,iEAAiE;;IAQjE,mFAAmF;;IAEnF,kFAAkF;;EAGrF"}
+{"version":3,"file":"useEditCanvas.d.ts","sourceRoot":"","sources":["../../src/hooks/useEditCanvas.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,IAAI,YAAY,EAAE,KAAK,YAAY,EAAW,MAAM,QAAQ,CAAC;AAC5E,OAAO,EAEL,KAAK,iBAAiB,EAEtB,KAAK,YAAY,EAClB,MAAM,aAAa,CAAC;AAMrB,OAAO,EAEL,KAAK,sBAAsB,EAE3B,KAAK,mBAAmB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,EAGL,KAAK,iBAAiB,EACvB,MAAM,iBAAiB,CAAC;AAQzB,OAAO,EAIL,KAAK,kBAAkB,EAExB,MAAM,eAAe,CAAC;AACvB,OAAO,EAEL,KAAK,cAAc,EAEpB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtD,MAAM,WAAW,oBAAoB;IACnC,kGAAkG;IAClG,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IACzC,mIAAmI;IACnI,SAAS,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IAC7C;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAC;IAC7C;;;;;OAKG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IACzC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,qEAAqE;IACrE,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAChD;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC9B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,cAAc,CAAC;IACnC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;IACjC;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC;IACxC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,aAAa,CAAC,OAAO,CAAC,EAAE,oBAAoB;IAqXtD,8CAA8C;sBAnSvC,YAAY;IAqSnB,oDAAoD;;IAEpD,qCAAqC;;IAErC,0EAA0E;;IAE1E,qDAAqD;;IAErD,6CAA6C;;IAE7C,yBAAyB;;QAtFzB,wCAAwC;;QAExC,wDAAwD;wBAbjB,YAAY;QAenD,wFAAwF;;QAExF,2DAA2D;;QAE3D,0DAA0D;;QAE1D,uDAAuD;;QAEvD,6DAA6D;;;IA4E7D,+DAA+D;;IAE/D;;;;;;;;;;;;;;OAcG;qBA1W6B,SAAS,GAAG,IAAI;IA4WhD;;;;;;;OAOG;yBAnEO,MAAM,WAAW;QAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAAE;IAqEzD,uIAAuI;;IAEvI,4DAA4D;;IAE5D,oGAAoG;;IAEpG,sDAAsD;;IAEtD,iEAAiE;;IAEjE,mFAAmF;;IAEnF,kFAAkF;;IAElF,gFAAgF;;IAEhF,wEAAwE;8BAtJ/B,OAAO;EAwKrD"}

package/dist/hooks/useViewCanvas.d.ts

@@ -1,5 +1,6 @@
 import { Canvas as FabricCanvas, type FabricObject } from 'fabric';
 import { type PanAndZoomOptions } from '../viewport';
+import type { CanvasJSON } from '../types';
 /** Visual properties that can be updated on view-canvas objects. */
 export interface ViewObjectStyle {
     fill?: string;
@@ -30,6 +31,23 @@ export interface UseViewCanvasOptions {
      * Pass a number to customize (default: 4), or `false` to disable.
      */
     borderRadius?: number | false;
+    /**
+     * Canvas data to load automatically after initialisation.
+     * When provided, `loadCanvas` is called internally before the user's
+     * `onReady` callback, and the resulting objects are available via the
+     * returned `objects` array.
+     */
+    canvasData?: CanvasJSON | object;
+    /**
+     * Filter function for loaded objects. Passed to `loadCanvas` as
+     * `options.filter`. Only relevant when `canvasData` is provided.
+     */
+    filter?: (obj: FabricObject) => boolean;
+    /**
+     * Whether the background image should have an Invert filter applied.
+     * Reactive — changes are applied automatically without remounting.
+     */
+    invertBackground?: boolean;
 }
 /**
  * Hook that provides a view-only canvas experience.
@@ -52,6 +70,10 @@ export declare function useViewCanvas(options?: UseViewCanvasOptions): {
     canvasRef: import("react").RefObject<FabricCanvas | null>;
     /** Current zoom level (reactive). */
     zoom: number;
+    /** Loaded objects (reactive). Populated when `canvasData` is provided. */
+    objects: FabricObject<Partial<import("fabric").FabricObjectProps>, import("fabric").SerializedObjectProps, import("fabric").ObjectEvents>[];
+    /** Whether canvas data is currently being loaded. */
+    isLoading: boolean;
     /** Viewport controls. */
     viewport: {
         /** Reset viewport to default (no pan, zoom = 1), or fit to background if one is set. */

package/dist/hooks/useViewCanvas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useViewCanvas.d.ts","sourceRoot":"","sources":["../../src/hooks/useViewCanvas.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,IAAI,YAAY,EAAE,KAAK,YAAY,EAAE,MAAM,QAAQ,CAAC;AACnE,OAAO,EAEL,KAAK,iBAAiB,EAEvB,MAAM,aAAa,CAAC;AASrB,oEAAoE;AACpE,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,kGAAkG;IAClG,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IACzC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qEAAqE;IACrE,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;CAC/B;AAUD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,CAAC,OAAO,CAAC,EAAE,oBAAoB;IA0HxD,8CAA8C;sBAjHrC,YAAY;IAmHrB,oDAAoD;;IAEpD,qCAAqC;;IAErC,yBAAyB;;QAEvB,wFAAwF;;QAExF,2DAA2D;;QAE3D,0DAA0D;;QAE1D,uDAAuD;;QAEvD,6DAA6D;;;IAG/D,8DAA8D;yBAnExB,MAAM,SAAS,eAAe;IAqEpE,sFAAsF;8BA5D7E,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC;IA8DxC,qEAAqE;iCAvC9D,MAAM,SAAS,eAAe;EA0CxC"}
+{"version":3,"file":"useViewCanvas.d.ts","sourceRoot":"","sources":["../../src/hooks/useViewCanvas.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,IAAI,YAAY,EAAE,KAAK,YAAY,EAAE,MAAM,QAAQ,CAAC;AACnE,OAAO,EAEL,KAAK,iBAAiB,EAEvB,MAAM,aAAa,CAAC;AASrB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C,oEAAoE;AACpE,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,kGAAkG;IAClG,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IACzC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qEAAqE;IACrE,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC9B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;IACjC;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC;IACxC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAUD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,CAAC,OAAO,CAAC,EAAE,oBAAoB;IA0KtD,8CAA8C;sBA/JvC,YAAY;IAiKnB,oDAAoD;;IAEpD,qCAAqC;;IAErC,0EAA0E;;IAE1E,qDAAqD;;IAErD,yBAAyB;;QAjFzB,wFAAwF;;QAExF,2DAA2D;;QAE3D,0DAA0D;;QAE1D,uDAAuD;;QAEvD,6DAA6D;;;IA2E7D,8DAA8D;yBA7D1B,MAAM,SAAS,eAAe;IA+DlE,sFAAsF;8BAtD/E,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC;IAwDtC,qEAAqE;iCAjChE,MAAM,SAAS,eAAe;EAwCxC"}