@tldraw/editor 3.16.0-canary.f56a36d13420 → 3.16.0-canary.f5bf2b535ea7

package/dist-esm/lib/editor/Editor.mjs

@@ -46,7 +46,7 @@ var __privateIn = (member, obj) => Object(obj) !== obj ? __typeError('Cannot use
 var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
 var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
 var __privateMethod = (obj, member, method) => (__accessCheck(obj, member, "access private method"), method);
-var __setMetaKeyTimeout_dec, __setCtrlKeyTimeout_dec, __setAltKeyTimeout_dec, __setShiftKeyTimeout_dec, _getIsReadonly_dec, _getIsFocused_dec, _getSharedOpacity_dec, _getSharedStyles_dec, __getSelectionSharedStyles_dec, __getBindingsIndexCache_dec, _getCurrentPageRenderingShapesSorted_dec, _getCurrentPageShapesSorted_dec, _getCurrentPageShapes_dec, _getCurrentPageBounds_dec, _getCulledShapes_dec, _getNotVisibleShapes_dec, __getShapeMaskedPageBoundsCache_dec, __getShapeMaskCache_dec, __getShapeClipPathCache_dec, __getShapePageBoundsCache_dec, __getShapePageTransformCache_dec, __getShapeHandlesCache_dec, __getAllAssetsQuery_dec, _getCurrentPageShapeIdsSorted_dec, _getCurrentPageId_dec, _getPages_dec, __getAllPagesQuery_dec, _getRenderingShapes_dec, _getCollaboratorsOnCurrentPage_dec, _getCollaborators_dec, __getCollaboratorsQuery_dec, _getViewportPageBounds_dec, _getViewportScreenCenter_dec, _getViewportScreenBounds_dec, _getZoomLevel_dec, _getCameraForFollowing_dec, _getViewportPageBoundsForFollowing_dec, _getCamera_dec, __unsafe_getCameraId_dec, _getErasingShapes_dec, _getErasingShapeIds_dec, _getHintingShape_dec, _getHintingShapeIds_dec, _getHoveredShape_dec, _getHoveredShapeId_dec, _getRichTextEditor_dec, _getEditingShape_dec, _getEditingShapeId_dec, _getFocusedGroup_dec, _getFocusedGroupId_dec, _getSelectionRotatedScreenBounds_dec, _getSelectionRotatedPageBounds_dec, _getSelectionRotation_dec, _getSelectionPageBounds_dec, _getOnlySelectedShape_dec, _getOnlySelectedShapeId_dec, _getCurrentPageShapesInReadingOrder_dec, _getSelectedShapes_dec, _getSelectedShapeIds_dec, __getCurrentPageStateId_dec, _getCurrentPageState_dec, __getPageStatesQuery_dec, _getPageStates_dec, _getIsMenuOpen_dec, _getOpenMenus_dec, _getInstanceState_dec, _getDocumentSettings_dec, _getCurrentToolId_dec, _getCurrentTool_dec, _getPath_dec, _getCanRedo_dec, _getCanUndo_dec, _getIsShapeHiddenCache_dec, _a, _init;
+var __setMetaKeyTimeout_dec, __setCtrlKeyTimeout_dec, __setAltKeyTimeout_dec, __setShiftKeyTimeout_dec, _getIsReadonly_dec, _getIsFocused_dec, _getSharedOpacity_dec, _getSharedStyles_dec, __getSelectionSharedStyles_dec, __getBindingsIndexCache_dec, _getCurrentPageRenderingShapesSorted_dec, _getCurrentPageShapesSorted_dec, _getCurrentPageShapes_dec, _getCurrentPageBounds_dec, _getCulledShapes_dec, _getNotVisibleShapes_dec, __getShapeMaskedPageBoundsCache_dec, __getShapeMaskCache_dec, __getShapeClipPathCache_dec, __getShapePageBoundsCache_dec, __getShapePageTransformCache_dec, __getShapeHandlesCache_dec, __getAllAssetsQuery_dec, _getCurrentPageShapeIdsSorted_dec, _getCurrentPageId_dec, _getPages_dec, __getAllPagesQuery_dec, _getRenderingShapes_dec, _getCollaboratorsOnCurrentPage_dec, _getCollaborators_dec, __getCollaboratorsQuery_dec, _getViewportPageBounds_dec, _getViewportScreenCenter_dec, _getViewportScreenBounds_dec, _getZoomLevel_dec, _getCameraForFollowing_dec, _getViewportPageBoundsForFollowing_dec, _getCamera_dec, __unsafe_getCameraId_dec, _getErasingShapes_dec, _getErasingShapeIds_dec, _getHintingShape_dec, _getHintingShapeIds_dec, _getHoveredShape_dec, _getHoveredShapeId_dec, _getRichTextEditor_dec, _getEditingShape_dec, _getEditingShapeId_dec, _getFocusedGroup_dec, _getFocusedGroupId_dec, _getSelectionRotatedScreenBounds_dec, _getSelectionRotatedPageBounds_dec, _getSelectionRotation_dec, _getSelectionPageBounds_dec, _getOnlySelectedShape_dec, _getOnlySelectedShapeId_dec, _getCurrentPageShapesInReadingOrder_dec, _getSelectedShapes_dec, _getSelectedShapeIds_dec, __getCurrentPageStateId_dec, _getCurrentPageState_dec, __getPageStatesQuery_dec, _getPageStates_dec, _getInstanceState_dec, _getDocumentSettings_dec, _getCurrentToolId_dec, _getCurrentTool_dec, _getPath_dec, _getCanRedo_dec, _getCanUndo_dec, _getIsShapeHiddenCache_dec, _a, _init;
 import {
   EMPTY_ARRAY,
   atom,
@@ -120,7 +120,6 @@ import {
 } from "../constants.mjs";
 import { exportToSvg } from "../exports/exportToSvg.mjs";
 import { getSvgAsImage } from "../exports/getSvgAsImage.mjs";
-import { tlenv } from "../globals/environment.mjs";
 import { tlmenus } from "../globals/menus.mjs";
 import { tltime } from "../globals/time.mjs";
 import { defaultTldrawOptions } from "../options.mjs";
@@ -158,7 +157,7 @@ import { TextManager } from "./managers/TextManager/TextManager.mjs";
 import { TickManager } from "./managers/TickManager/TickManager.mjs";
 import { UserPreferencesManager } from "./managers/UserPreferencesManager/UserPreferencesManager.mjs";
 import { RootState } from "./tools/RootState.mjs";
-class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed], _getCanUndo_dec = [computed], _getCanRedo_dec = [computed], _getPath_dec = [computed], _getCurrentTool_dec = [computed], _getCurrentToolId_dec = [computed], _getDocumentSettings_dec = [computed], _getInstanceState_dec = [computed], _getOpenMenus_dec = [computed], _getIsMenuOpen_dec = [computed], _getPageStates_dec = [computed], __getPageStatesQuery_dec = [computed], _getCurrentPageState_dec = [computed], __getCurrentPageStateId_dec = [computed], _getSelectedShapeIds_dec = [computed], _getSelectedShapes_dec = [computed], _getCurrentPageShapesInReadingOrder_dec = [computed], _getOnlySelectedShapeId_dec = [computed], _getOnlySelectedShape_dec = [computed], _getSelectionPageBounds_dec = [computed], _getSelectionRotation_dec = [computed], _getSelectionRotatedPageBounds_dec = [computed], _getSelectionRotatedScreenBounds_dec = [computed], _getFocusedGroupId_dec = [computed], _getFocusedGroup_dec = [computed], _getEditingShapeId_dec = [computed], _getEditingShape_dec = [computed], _getRichTextEditor_dec = [computed], _getHoveredShapeId_dec = [computed], _getHoveredShape_dec = [computed], _getHintingShapeIds_dec = [computed], _getHintingShape_dec = [computed], _getErasingShapeIds_dec = [computed], _getErasingShapes_dec = [computed], __unsafe_getCameraId_dec = [computed], _getCamera_dec = [computed], _getViewportPageBoundsForFollowing_dec = [computed], _getCameraForFollowing_dec = [computed], _getZoomLevel_dec = [computed], _getViewportScreenBounds_dec = [computed], _getViewportScreenCenter_dec = [computed], _getViewportPageBounds_dec = [computed], __getCollaboratorsQuery_dec = [computed], _getCollaborators_dec = [computed], _getCollaboratorsOnCurrentPage_dec = [computed], _getRenderingShapes_dec = [computed], __getAllPagesQuery_dec = [computed], _getPages_dec = [computed], _getCurrentPageId_dec = [computed], _getCurrentPageShapeIdsSorted_dec = [computed], __getAllAssetsQuery_dec = [computed], __getShapeHandlesCache_dec = [computed], __getShapePageTransformCache_dec = [computed], __getShapePageBoundsCache_dec = [computed], __getShapeClipPathCache_dec = [computed], __getShapeMaskCache_dec = [computed], __getShapeMaskedPageBoundsCache_dec = [computed], _getNotVisibleShapes_dec = [computed], _getCulledShapes_dec = [computed], _getCurrentPageBounds_dec = [computed], _getCurrentPageShapes_dec = [computed], _getCurrentPageShapesSorted_dec = [computed], _getCurrentPageRenderingShapesSorted_dec = [computed], __getBindingsIndexCache_dec = [computed], __getSelectionSharedStyles_dec = [computed], _getSharedStyles_dec = [computed({ isEqual: (a, b) => a.equals(b) })], _getSharedOpacity_dec = [computed], _getIsFocused_dec = [computed], _getIsReadonly_dec = [computed], __setShiftKeyTimeout_dec = [bind], __setAltKeyTimeout_dec = [bind], __setCtrlKeyTimeout_dec = [bind], __setMetaKeyTimeout_dec = [bind], _a) {
+class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed], _getCanUndo_dec = [computed], _getCanRedo_dec = [computed], _getPath_dec = [computed], _getCurrentTool_dec = [computed], _getCurrentToolId_dec = [computed], _getDocumentSettings_dec = [computed], _getInstanceState_dec = [computed], _getPageStates_dec = [computed], __getPageStatesQuery_dec = [computed], _getCurrentPageState_dec = [computed], __getCurrentPageStateId_dec = [computed], _getSelectedShapeIds_dec = [computed], _getSelectedShapes_dec = [computed], _getCurrentPageShapesInReadingOrder_dec = [computed], _getOnlySelectedShapeId_dec = [computed], _getOnlySelectedShape_dec = [computed], _getSelectionPageBounds_dec = [computed], _getSelectionRotation_dec = [computed], _getSelectionRotatedPageBounds_dec = [computed], _getSelectionRotatedScreenBounds_dec = [computed], _getFocusedGroupId_dec = [computed], _getFocusedGroup_dec = [computed], _getEditingShapeId_dec = [computed], _getEditingShape_dec = [computed], _getRichTextEditor_dec = [computed], _getHoveredShapeId_dec = [computed], _getHoveredShape_dec = [computed], _getHintingShapeIds_dec = [computed], _getHintingShape_dec = [computed], _getErasingShapeIds_dec = [computed], _getErasingShapes_dec = [computed], __unsafe_getCameraId_dec = [computed], _getCamera_dec = [computed], _getViewportPageBoundsForFollowing_dec = [computed], _getCameraForFollowing_dec = [computed], _getZoomLevel_dec = [computed], _getViewportScreenBounds_dec = [computed], _getViewportScreenCenter_dec = [computed], _getViewportPageBounds_dec = [computed], __getCollaboratorsQuery_dec = [computed], _getCollaborators_dec = [computed], _getCollaboratorsOnCurrentPage_dec = [computed], _getRenderingShapes_dec = [computed], __getAllPagesQuery_dec = [computed], _getPages_dec = [computed], _getCurrentPageId_dec = [computed], _getCurrentPageShapeIdsSorted_dec = [computed], __getAllAssetsQuery_dec = [computed], __getShapeHandlesCache_dec = [computed], __getShapePageTransformCache_dec = [computed], __getShapePageBoundsCache_dec = [computed], __getShapeClipPathCache_dec = [computed], __getShapeMaskCache_dec = [computed], __getShapeMaskedPageBoundsCache_dec = [computed], _getNotVisibleShapes_dec = [computed], _getCulledShapes_dec = [computed], _getCurrentPageBounds_dec = [computed], _getCurrentPageShapes_dec = [computed], _getCurrentPageShapesSorted_dec = [computed], _getCurrentPageRenderingShapesSorted_dec = [computed], __getBindingsIndexCache_dec = [computed], __getSelectionSharedStyles_dec = [computed], _getSharedStyles_dec = [computed({ isEqual: (a, b) => a.equals(b) })], _getSharedOpacity_dec = [computed], _getIsFocused_dec = [computed], _getIsReadonly_dec = [computed], __setShiftKeyTimeout_dec = [bind], __setAltKeyTimeout_dec = [bind], __setCtrlKeyTimeout_dec = [bind], __setMetaKeyTimeout_dec = [bind], _a) {
   constructor({
     store,
     user,
@@ -172,8 +171,6 @@ class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed]
     autoFocus,
     inferDarkMode,
     options,
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    isShapeHidden,
     getShapeVisibility,
     fontAssetUrls
   }) {
@@ -240,13 +237,6 @@ class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed]
      * @public
      */
     __publicField(this, "fonts");
-    /**
-     * A manager for the editor's environment.
-     *
-     * @deprecated This is deprecated and will be removed in a future version. Use the `tlenv` global export instead.
-     * @public
-     */
-    __publicField(this, "environment", tlenv);
     /**
      * A manager for the editor's scribbles.
      *
@@ -448,15 +438,10 @@ class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed]
     __publicField(this, "performanceTracker");
     /** @internal */
     __publicField(this, "performanceTrackerTimeout", -1);
+    /** @internal */
+    __publicField(this, "handledEvents", /* @__PURE__ */ new WeakSet());
     __publicField(this, "_pendingEventsForNextTick", []);
-    assert(
-      !(isShapeHidden && getShapeVisibility),
-      "Cannot use both isShapeHidden and getShapeVisibility"
-    );
-    this._getShapeVisibility = isShapeHidden ? (
-      // eslint-disable-next-line @typescript-eslint/no-deprecated
-      ((shape, editor) => isShapeHidden(shape, editor) ? "hidden" : "inherit")
-    ) : getShapeVisibility;
+    this._getShapeVisibility = getShapeVisibility;
     this.options = { ...defaultTldrawOptions, ...options };
     this.store = store;
     this.history = new HistoryManager({
@@ -482,6 +467,7 @@ class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed]
     }
     this.root = new NewRoot(this);
     this.root.children = {};
+    this.markEventAsHandled = this.markEventAsHandled.bind(this);
     const allShapeUtils = checkShapesAndAddCore(shapeUtils);
     const _shapeUtils = {};
     const _styleProps = {};
@@ -936,34 +922,6 @@ class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed]
   getCanRedo() {
     return this.history.getNumRedos() > 0;
   }
-  /**
-   * Create a new "mark", or stopping point, in the undo redo history. Creating a mark will clear
-   * any redos.
-   *
-   * @example
-   * ```ts
-   * editor.mark()
-   * editor.mark('flip shapes')
-   * ```
-   *
-   * @param markId - The mark's id, usually the reason for adding the mark.
-   *
-   * @public
-   * @deprecated use {@link Editor.markHistoryStoppingPoint} instead
-   */
-  mark(markId) {
-    if (typeof markId === "string") {
-      console.warn(
-        `[tldraw] \`editor.history.mark("${markId}")\` is deprecated. Please use \`const myMarkId = editor.markHistoryStoppingPoint()\` instead.`
-      );
-    } else {
-      console.warn(
-        "[tldraw] `editor.mark()` is deprecated. Use `editor.markHistoryStoppingPoint()` instead."
-      );
-    }
-    this.history._mark(markId ?? uniqueId());
-    return this;
-  }
   /**
    * Create a new "mark", or stopping point, in the undo redo history. Creating a mark will clear
    * any redos. You typically want to do this just before a user interaction begins or is handled.
@@ -1079,12 +1037,6 @@ class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed]
     }
     return this;
   }
-  /**
-   * @deprecated Use `Editor.run` instead.
-   */
-  batch(fn, opts) {
-    return this.run(fn, opts);
-  }
   /* --------------------- Errors --------------------- */
   /** @internal */
   annotateError(error, {
@@ -1306,39 +1258,6 @@ class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed]
       ]);
     }, opts);
   }
-  getOpenMenus() {
-    return this.menus.getOpenMenus();
-  }
-  /**
-   * @deprecated Use `editor.menus.addOpenMenu` instead.
-   *
-   * @public
-   */
-  addOpenMenu(id) {
-    this.menus.addOpenMenu(id);
-    return this;
-  }
-  /**
-   * @deprecated Use `editor.menus.deleteOpenMenu` instead.
-   *
-   * @public
-   */
-  deleteOpenMenu(id) {
-    this.menus.deleteOpenMenu(id);
-    return this;
-  }
-  /**
-   * @deprecated Use `editor.menus.clearOpenMenus` instead.
-   *
-   * @public
-   */
-  clearOpenMenus() {
-    this.menus.clearOpenMenus();
-    return this;
-  }
-  getIsMenuOpen() {
-    return this.menus.hasAnyOpenMenus();
-  }
   /* --------------------- Cursor --------------------- */
   /**
    * Set the cursor.
@@ -3646,8 +3565,9 @@ class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed]
     return this.store.createComputedCache("pageBoundsCache", (shape) => {
       const pageTransform = this.getShapePageTransform(shape);
       if (!pageTransform) return void 0;
-      const geometry = this.getShapeGeometry(shape);
-      return Box.FromPoints(pageTransform.applyToPoints(geometry.vertices));
+      return Box.FromPoints(
+        pageTransform.applyToPoints(this.getShapeGeometry(shape).boundsVertices)
+      );
     });
   }
   /**
@@ -4408,10 +4328,6 @@ class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed]
     }
     return shapeIds;
   }
-  /** @deprecated Use {@link Editor.getDraggingOverShape} instead */
-  getDroppingOverShape(point, droppingShapes) {
-    return this.getDraggingOverShape(point, droppingShapes);
-  }
   /**
    * Get the shape that some shapes should be dropped on at a given point.
    *
@@ -6559,16 +6475,20 @@ class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed]
    * Handle external content, such as files, urls, embeds, or plain text which has been put into the app, for example by pasting external text or dropping external images onto canvas.
    *
    * @param info - Info about the external content.
+   * @param opts - Options for handling external content, including force flag to bypass readonly checks.
    */
-  async putExternalContent(info) {
+  async putExternalContent(info, opts = {}) {
+    if (!opts.force && this.getIsReadonly()) return;
     return this.externalContentHandlers[info.type]?.(info);
   }
   /**
    * Handle replacing external content.
    *
    * @param info - Info about the external content.
+   * @param opts - Options for handling external content, including force flag to bypass readonly checks.
    */
-  async replaceExternalContent(info) {
+  async replaceExternalContent(info, opts = {}) {
+    if (!opts.force && this.getIsReadonly()) return;
     return this.externalContentHandlers[info.type]?.(info);
   }
   /**
@@ -6922,12 +6842,6 @@ class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed]
       height: result.height
     };
   }
-  /** @deprecated Use {@link Editor.getSvgString} or {@link Editor.getSvgElement} instead. */
-  async getSvg(shapes, opts = {}) {
-    const result = await this.getSvgElement(shapes, opts);
-    if (!result) return void 0;
-    return result.svg;
-  }
   /**
    * Get an exported image of the given shapes.
    *
@@ -7494,6 +7408,32 @@ class Editor extends (_a = EventEmitter, _getIsShapeHiddenCache_dec = [computed]
       code: "MetaLeft"
     });
   }
+  /**
+   * In tldraw, events are sometimes handled by multiple components. For example, the shapes might
+   * have events, but the canvas handles events too. The way that the canvas handles events can
+   * interfere with the with the shapes event handlers - for example, it calls `.preventDefault()`
+   * on `pointerDown`, which also prevents `click` events from firing on the shapes.
+   *
+   * You can use `.stopPropagation()` to prevent the event from propagating to the rest of the
+   * DOM, but that can impact non-tldraw event handlers set up elsewhere. By using
+   * `markEventAsHandled`, you'll stop other parts of tldraw from handling the event without
+   * impacting other, non-tldraw event handlers. See also {@link Editor.wasEventAlreadyHandled}.
+   *
+   * @public
+   */
+  markEventAsHandled(e) {
+    const nativeEvent = "nativeEvent" in e ? e.nativeEvent : e;
+    this.handledEvents.add(nativeEvent);
+  }
+  /**
+   * Checks if an event has already been handled. See {@link Editor.markEventAsHandled}.
+   *
+   * @public
+   */
+  wasEventAlreadyHandled(e) {
+    const nativeEvent = "nativeEvent" in e ? e.nativeEvent : e;
+    return this.handledEvents.has(nativeEvent);
+  }
   /**
    * Dispatch an event to the editor.
    *
@@ -7908,8 +7848,6 @@ __decorateElement(_init, 1, "getCurrentTool", _getCurrentTool_dec, Editor);
 __decorateElement(_init, 1, "getCurrentToolId", _getCurrentToolId_dec, Editor);
 __decorateElement(_init, 1, "getDocumentSettings", _getDocumentSettings_dec, Editor);
 __decorateElement(_init, 1, "getInstanceState", _getInstanceState_dec, Editor);
-__decorateElement(_init, 1, "getOpenMenus", _getOpenMenus_dec, Editor);
-__decorateElement(_init, 1, "getIsMenuOpen", _getIsMenuOpen_dec, Editor);
 __decorateElement(_init, 1, "getPageStates", _getPageStates_dec, Editor);
 __decorateElement(_init, 1, "_getPageStatesQuery", __getPageStatesQuery_dec, Editor);
 __decorateElement(_init, 1, "getCurrentPageState", _getCurrentPageState_dec, Editor);