@bwp-web/canvas 0.8.2 → 0.8.3

package/dist/overlay/FixedSizeContent.d.ts

@@ -35,7 +35,7 @@ export interface FixedSizeContentProps extends StackProps {
  *
  * @example
  * ```tsx
- * <ObjectOverlay canvasRef={canvasRef} object={obj}>
+ * <ObjectOverlay object={obj}>
  *   <OverlayContent>
  *     <Stack alignItems="center">
  *       <MyIcon />                      {// scales to fit}

package/dist/overlay/ObjectOverlay.d.ts

@@ -2,8 +2,13 @@ import { type RefObject, type ReactNode } from 'react';
 import type { StackProps } from '@mui/material';
 import type { Canvas as FabricCanvas, FabricObject } from 'fabric';
 export interface ObjectOverlayProps extends StackProps {
-    /** Ref to the Fabric canvas instance. */
-    canvasRef: RefObject<FabricCanvas | null>;
+    /**
+     * Ref to the Fabric canvas instance.
+     * Optional when rendered inside a {@link ViewCanvasProvider} or
+     * {@link EditCanvasProvider} — the ref is read from context automatically.
+     * If provided, takes precedence over the context value.
+     */
+    canvasRef?: RefObject<FabricCanvas | null>;
     /** The Fabric object to overlay. When `null`/`undefined`, nothing renders. */
     object: FabricObject | null | undefined;
     children?: ReactNode;
@@ -22,6 +27,14 @@ export interface ObjectOverlayProps extends StackProps {
  *
  * @example
  * ```tsx
+ * // Inside a ViewCanvasProvider or EditCanvasProvider — canvasRef is read from context:
+ * <ObjectOverlay object={deskObj}>
+ *   <OverlayContent>
+ *     <MyLabel>{desk.name}</MyLabel>
+ *   </OverlayContent>
+ * </ObjectOverlay>
+ *
+ * // Or pass canvasRef explicitly:
  * <ObjectOverlay canvasRef={canvasRef} object={deskObj}>
  *   <OverlayContent>
  *     <MyLabel>{desk.name}</MyLabel>
@@ -29,5 +42,5 @@ export interface ObjectOverlayProps extends StackProps {
  * </ObjectOverlay>
  * ```
  */
-export declare function ObjectOverlay({ canvasRef, object, sx, children, ...rest }: ObjectOverlayProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function ObjectOverlay({ canvasRef: canvasRefProp, object, sx, children, ...rest }: ObjectOverlayProps): import("react/jsx-runtime").JSX.Element | null;
 //# sourceMappingURL=ObjectOverlay.d.ts.map

package/dist/overlay/ObjectOverlay.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ObjectOverlay.d.ts","sourceRoot":"","sources":["../../src/overlay/ObjectOverlay.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAE1E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,MAAM,IAAI,YAAY,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGnE,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,yCAAyC;IACzC,SAAS,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IAC1C,8EAA8E;IAC9E,MAAM,EAAE,YAAY,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,aAAa,CAAC,EAC5B,SAAS,EACT,MAAM,EACN,EAAE,EACF,QAAQ,EACR,GAAG,IAAI,EACR,EAAE,kBAAkB,kDA+DpB"}
+{"version":3,"file":"ObjectOverlay.d.ts","sourceRoot":"","sources":["../../src/overlay/ObjectOverlay.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAE1E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,MAAM,IAAI,YAAY,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAInE,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD;;;;;OAKG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IAC3C,8EAA8E;IAC9E,MAAM,EAAE,YAAY,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,aAAa,CAAC,EAC5B,SAAS,EAAE,aAAa,EACxB,MAAM,EACN,EAAE,EACF,QAAQ,EACR,GAAG,IAAI,EACR,EAAE,kBAAkB,kDAkEpB"}

package/dist/overlay/OverlayBadge.d.ts

@@ -44,7 +44,7 @@ export interface OverlayBadgeProps extends StackProps {
  *
  * @example
  * ```tsx
- * <ObjectOverlay canvasRef={canvasRef} object={obj}>
+ * <ObjectOverlay object={obj}>
  *   <OverlayContent>
  *     <MyIcon />
  *     <FixedSizeContent><Typography>Label</Typography></FixedSizeContent>

package/dist/overlay/OverlayContent.d.ts

@@ -15,7 +15,7 @@ export interface OverlayContentProps extends StackProps {
  *
  * @example
  * ```tsx
- * <ObjectOverlay canvasRef={canvasRef} object={obj}>
+ * <ObjectOverlay object={obj}>
  *   <OverlayContent padding={4} maxScale={2}>
  *     <MyBadge>{label}</MyBadge>
  *   </OverlayContent>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bwp-web/canvas",
-  "version": "0.8.2",
+  "version": "0.8.3",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",