@tldraw/editor 3.16.0-canary.1e91d2e19e07 → 3.16.0-canary.1f09406e5b86

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

@@ -438,6 +438,8 @@ 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", []);
     this._getShapeVisibility = getShapeVisibility;
     this.options = { ...defaultTldrawOptions, ...options };
@@ -465,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 = {};
@@ -6472,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);
   }
   /**
@@ -7401,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.
    *