@atlaskit/pragmatic-drag-and-drop 0.21.0 → 0.23.0

package/CHANGELOG.md

@@ -1,5 +1,64 @@
 # @atlaskit/pragmatic-drag-and-drop
 
+## 0.23.0
+
+### Minor Changes
+
+- [`3da89e29dfc`](https://bitbucket.org/atlassian/atlassian-frontend/commits/3da89e29dfc) - We have renamed and tweaked the recently added `setCustomNativeDragPreview` `getOffset` utility `preserveOffsetFromPointer` to be a bit easier to understand what it is doing.
+
+  ```diff
+  - import { preserveOffsetFromPointer } from '@atlaskit/pragmatic-drag-and-drop/util/preserve-offset-from-pointer';
+  + import { preserveOffsetOnSource } from '@atlaskit/pragmatic-drag-and-drop/util/preserve-offset-on-source';
+
+  draggable({
+    element: myElement,
+    onGenerateDragPreview: ({ nativeSetDragImage, location, source }) => {
+      setCustomNativeDragPreview({
+  -      getOffset: preserveOffsetFromPointer({
+  +      'preserveOffsetOnSource' is a more accurate description of what is being achieved
+  +      getOffset: preserveOffsetOnSource({
+  -        sourceElement: source.element,
+  +        // no longer including 'source' in argument name
+  +        // as it is implied by the function name
+  +        element: source.element,
+          input: location.current.input,
+        }),
+        render: function render({ container }) {
+          /* ... */
+        },
+        nativeSetDragImage,
+      });
+    },
+  });
+  ```
+
+## 0.22.0
+
+### Minor Changes
+
+- [`d644a68ddf6`](https://bitbucket.org/atlassian/atlassian-frontend/commits/d644a68ddf6) - Added a new `setCustomNativeDragPreview` `getOffset` utility: `preserveOffsetFromPointer`. `preserveOffsetFromPointer` mimics the default behaviour for non custom drag previews when starting a drag: the initial cursor position offset is preserved for a seamless drag and drop experience.
+
+  ```ts
+  import { setCustomNativeDragPreview } from '@atlaskit/pragmatic-drag-and-drop/util/set-custom-native-drag-preview';
+  import { preserveOffsetFromPointer } from '@atlaskit/pragmatic-drag-and-drop/util/preserve-offset-from-pointer';
+
+  draggable({
+    element: myElement,
+    onGenerateDragPreview: ({ nativeSetDragImage, location, source }) => {
+      setCustomNativeDragPreview({
+        getOffset: preserveOffsetFromPointer({
+          sourceElement: source.element,
+          input: location.current.input,
+        }),
+        render: function render({ container }) {
+          /* ... */
+        },
+        nativeSetDragImage,
+      });
+    },
+  });
+  ```
+
 ## 0.21.0
 
 ### Minor Changes

package/dist/cjs/entry-point/util/preserve-offset-on-source.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "preserveOffsetOnSource", {
+  enumerable: true,
+  get: function get() {
+    return _preserveOffsetOnSource.preserveOffsetOnSource;
+  }
+});
+var _preserveOffsetOnSource = require("../../util/custom-native-drag-preview/preserve-offset-on-source");

package/dist/cjs/util/custom-native-drag-preview/preserve-offset-on-source.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.preserveOffsetOnSource = preserveOffsetOnSource;
+function preserveOffsetOnSource(_ref) {
+  var element = _ref.element,
+    input = _ref.input;
+  return function (_ref2) {
+    var container = _ref2.container;
+    var sourceRect = element.getBoundingClientRect();
+    var containerRect = container.getBoundingClientRect();
+    var offsetX = Math.min(
+    // difference
+    input.clientX - sourceRect.x,
+    // don't let the difference be more than the width of the container,
+    // otherwise the pointer will be off the preview
+    containerRect.width);
+    var offsetY = Math.min(
+    // difference
+    input.clientY - sourceRect.y,
+    // don't let the difference be more than the height of the container,
+    // otherwise the pointer will be off the preview
+    containerRect.height);
+    return {
+      x: offsetX,
+      y: offsetY
+    };
+  };
+}

package/dist/es2019/entry-point/util/preserve-offset-on-source.js

@@ -0,0 +1 @@
+export { preserveOffsetOnSource } from '../../util/custom-native-drag-preview/preserve-offset-on-source';

package/dist/es2019/util/custom-native-drag-preview/preserve-offset-on-source.js

@@ -0,0 +1,27 @@
+export function preserveOffsetOnSource({
+  element,
+  input
+}) {
+  return ({
+    container
+  }) => {
+    const sourceRect = element.getBoundingClientRect();
+    const containerRect = container.getBoundingClientRect();
+    const offsetX = Math.min(
+    // difference
+    input.clientX - sourceRect.x,
+    // don't let the difference be more than the width of the container,
+    // otherwise the pointer will be off the preview
+    containerRect.width);
+    const offsetY = Math.min(
+    // difference
+    input.clientY - sourceRect.y,
+    // don't let the difference be more than the height of the container,
+    // otherwise the pointer will be off the preview
+    containerRect.height);
+    return {
+      x: offsetX,
+      y: offsetY
+    };
+  };
+}

package/dist/esm/entry-point/util/preserve-offset-on-source.js

@@ -0,0 +1 @@
+export { preserveOffsetOnSource } from '../../util/custom-native-drag-preview/preserve-offset-on-source';

package/dist/esm/util/custom-native-drag-preview/preserve-offset-on-source.js

@@ -0,0 +1,25 @@
+export function preserveOffsetOnSource(_ref) {
+  var element = _ref.element,
+    input = _ref.input;
+  return function (_ref2) {
+    var container = _ref2.container;
+    var sourceRect = element.getBoundingClientRect();
+    var containerRect = container.getBoundingClientRect();
+    var offsetX = Math.min(
+    // difference
+    input.clientX - sourceRect.x,
+    // don't let the difference be more than the width of the container,
+    // otherwise the pointer will be off the preview
+    containerRect.width);
+    var offsetY = Math.min(
+    // difference
+    input.clientY - sourceRect.y,
+    // don't let the difference be more than the height of the container,
+    // otherwise the pointer will be off the preview
+    containerRect.height);
+    return {
+      x: offsetX,
+      y: offsetY
+    };
+  };
+}

package/dist/types/entry-point/util/preserve-offset-on-source.d.ts

@@ -0,0 +1 @@
+export { preserveOffsetOnSource } from '../../util/custom-native-drag-preview/preserve-offset-on-source';

package/dist/types/util/custom-native-drag-preview/preserve-offset-on-source.d.ts

@@ -0,0 +1,6 @@
+import { Input } from '../../entry-point/types';
+import type { GetOffsetFn } from './types';
+export declare function preserveOffsetOnSource({ element, input, }: {
+    element: HTMLElement;
+    input: Input;
+}): GetOffsetFn;

package/dist/types-ts4.5/entry-point/util/preserve-offset-on-source.d.ts

@@ -0,0 +1 @@
+export { preserveOffsetOnSource } from '../../util/custom-native-drag-preview/preserve-offset-on-source';

package/dist/types-ts4.5/util/custom-native-drag-preview/preserve-offset-on-source.d.ts

@@ -0,0 +1,6 @@
+import { Input } from '../../entry-point/types';
+import type { GetOffsetFn } from './types';
+export declare function preserveOffsetOnSource({ element, input, }: {
+    element: HTMLElement;
+    input: Input;
+}): GetOffsetFn;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/pragmatic-drag-and-drop",
-  "version": "0.21.0",
+  "version": "0.23.0",
   "description": "The core Pragmatic drag and drop framework, optimized for performance.",
   "repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
   "author": "Atlassian Pty Ltd",
@@ -46,6 +46,7 @@
     "./util/set-custom-native-drag-preview": "./src/entry-point/util/set-custom-native-drag-preview.ts",
     "./util/offset-from-pointer": "./src/entry-point/util/offset-from-pointer.ts",
     "./util/center-under-pointer": "./src/entry-point/util/center-under-pointer.ts",
+    "./util/preserve-offset-on-source": "./src/entry-point/util/preserve-offset-on-source.ts",
     "./util/disable-native-drag-preview": "./src/entry-point/util/disable-native-drag-preview.ts",
     "./util/scroll-just-enough-into-view": "./src/entry-point/util/scroll-just-enough-into-view.ts",
     "./experimental/cross-window-element-adapter": "./src/entry-point/experimental/cross-with-element-adapter.ts"

package/util/preserve-offset-on-source/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/pragmatic-drag-and-drop/util/preserve-offset-on-source",
+  "main": "../../dist/cjs/entry-point/util/preserve-offset-on-source.js",
+  "module": "../../dist/esm/entry-point/util/preserve-offset-on-source.js",
+  "module:es2019": "../../dist/es2019/entry-point/util/preserve-offset-on-source.js",
+  "sideEffects": false,
+  "types": "../../dist/types/entry-point/util/preserve-offset-on-source.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "../../dist/types-ts4.5/entry-point/util/preserve-offset-on-source.d.ts"
+      ]
+    }
+  }
+}

package/dist/cjs/version.json

@@ -1,5 +0,0 @@
-{
-	"name": "@atlaskit/pragmatic-drag-and-drop",
-	"version": "0.21.0",
-	"sideEffects": false
-}

package/dist/es2019/version.json

@@ -1,5 +0,0 @@
-{
-	"name": "@atlaskit/pragmatic-drag-and-drop",
-	"version": "0.21.0",
-	"sideEffects": false
-}

package/dist/esm/version.json

@@ -1,5 +0,0 @@
-{
-	"name": "@atlaskit/pragmatic-drag-and-drop",
-	"version": "0.21.0",
-	"sideEffects": false
-}