perf: add API for disabling auto-scroll due to performance issues

measuredco · Apr 17, 2024 · 3e5599e · 3e5599e
1 parent e038522
commit 3e5599e
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/apps/docs/pages/docs/api-reference/components/puck.mdx b/apps/docs/pages/docs/api-reference/components/puck.mdx
@@ -156,9 +156,14 @@ export function Editor() {
 
 #### iframe params
 
-| Param                 | Example          | Type    | Status |
-| --------------------- | ---------------- | ------- | ------ |
-| [`enabled`](#enabled) | `enabled: false` | boolean | -      |
+| Param                                     | Example                   | Type    | Status |
+| ----------------------------------------- | ------------------------- | ------- | ------ |
+| [`disableAutoScroll`](#disableautoscroll) | `disableAutoScroll: true` | boolean | -      |
+| [`enabled`](#enabled)                     | `enabled: false`          | boolean | -      |
+
+##### `disableAutoScroll`
+
+Disable auto-scroll of the iframe when the user drag an item near the edge.
 
 ##### `enabled`
 

diff --git a/packages/core/components/Puck/index.tsx b/packages/core/components/Puck/index.tsx
@@ -368,6 +368,7 @@ export function Puck<UserConfig extends Config = Config>({
         }}
       >
         <DragDropContext
+          autoScrollerOptions={{ disabled: iframe.disableAutoScroll }}
           onDragUpdate={(update) => {
             setDraggedItem({ ...draggedItem, ...update });
             onDragStartOrUpdate(update);

diff --git a/packages/core/types/IframeConfig.tsx b/packages/core/types/IframeConfig.tsx
@@ -1,3 +1,4 @@
 export type IframeConfig = {
   enabled?: boolean;
+  disableAutoScroll?: boolean;
 };